| Index: README.md
|
| diff --git a/README.md b/README.md
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..bfb9f1420acad01b30a1ff562a0d9b662cc17a73
|
| --- /dev/null
|
| +++ b/README.md
|
| @@ -0,0 +1,47 @@
|
| +# Breakpad
|
| +
|
| +Breakpad is a set of client and server components which implement a
|
| +crash-reporting system.
|
| +
|
| +## Getting started in 32-bit mode (from trunk)
|
| +
|
| +```sh
|
| +# Configure
|
| +CXXFLAGS=-m32 CFLAGS=-m32 CPPFLAGS=-m32 ./configure
|
| +# Build
|
| +make
|
| +# Test
|
| +make check
|
| +# Install
|
| +make install
|
| +```
|
| +
|
| +If you need to reconfigure your build be sure to run `make distclean` first.
|
| +
|
| +## To request change review:
|
| +
|
| +1. Get a copy of depot_tools repo.
|
| + http://dev.chromium.org/developers/how-tos/install-depot-tools
|
| +
|
| +2. Create a new directory for checking out the source code.
|
| + mkdir breakpad && cd breakpad
|
| +
|
| +3. Run the `fetch` tool from depot_tools to download all the source repos.
|
| + `fetch breakpad`
|
| +
|
| +4. Make changes. Build and test your changes.
|
| + For core code like processor use methods above.
|
| + For linux/mac/windows, there are test targets in each project file.
|
| +
|
| +5. Commit your changes to your local repo and upload them to the server.
|
| + http://dev.chromium.org/developers/contributing-code
|
| + e.g. `git commit ... && git cl upload ...`
|
| + You will be prompted for credential and a description.
|
| +
|
| +6. At https://codereview.chromium.org/ you'll find your issue listed; click on
|
| + it, and select Publish+Mail, and enter in the code reviewer and CC
|
| + google-breakpad-dev@googlegroups.com
|
| +
|
| +## Documentation
|
| +
|
| +Visit https://chromium.googlesource.com/breakpad/breakpad/+/master/docs/
|
|
|