[Docs] add markdown docs (converted from Wiki)

BUG=none
R=mark
CC=google-breakpad-dev@googlegroups.com

Review URL: https://codereview.chromium.org/1357773004 .

Patch from Andy Bonventre <andybons@chromium.org>.
17 files changed
tree: c670617291b3476ab2622d7ea2509d8369db2f0d
  1. android/
  2. autotools/
  3. docs/
  4. m4/
  5. src/
  6. .gitignore
  7. aclocal.m4
  8. AUTHORS
  9. breakpad-client.pc.in
  10. breakpad.pc.in
  11. ChangeLog
  12. codereview.settings
  13. configure
  14. configure.ac
  15. DEPS
  16. INSTALL
  17. LICENSE
  18. Makefile.am
  19. Makefile.in
  20. NEWS
  21. README.ANDROID
  22. README.md
README.md

Breakpad

Breakpad is a set of client and server components which implement a crash-reporting system.

Getting started in 32-bit mode (from trunk)

# 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/