Skip to content

Commit 9b583bc

Browse files
authored
Update README.md
1 parent 056682c commit 9b583bc

File tree

1 file changed

+44
-7
lines changed

1 file changed

+44
-7
lines changed

README.md

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,58 @@
11
# Stackwalker [![Build Status](https://travis-ci.org/NatronGitHub/stackwalker.svg)](https://travis-ci.org/NatronGitHub/stackwalker)
22

3-
4-
Stackwalker and Breakdown is used to process crash reports from Breakpad.
5-
6-
*This is a fork of Google Breakpad and Mozilla Socorro with additional features/changes maintained for Natron.*
3+
The stackwalker project includes applications used to process crash reports from Breakpad.
74

85
## Requirements
96

107
* pkg-config
118
* libcurl
129
* libzip
1310
* jsoncpp
14-
* qtbase
11+
* qtbase (Breakdown)
1512
* cmake
16-
* php
13+
* php (server-side)
14+
15+
### MSYS2
16+
17+
Add the required dependencies:
18+
```
19+
pacman -S tar git make mingw-w64-x86_64-{toolchain,cmake,curl,libzip,jsoncpp,qt5}
20+
```
21+
22+
### MXE
23+
24+
Add the required dependencies:
25+
```
26+
make cc cmake jsoncpp curl libzip qtbase
27+
```
28+
29+
## Applications
30+
31+
The stackwalker project contains the following applications:
32+
33+
### Breakdown
34+
35+
TODO.
36+
37+
### Stackwalker
38+
39+
Commandline application that parses mindumps against symbols and outputs a JSON.
40+
41+
### dump_syms
42+
43+
WIN32 TODO. Need to port from Natron google-breakpad fork.
44+
45+
## Build
46+
47+
```
48+
mkdir build && cd build
49+
cmake ..
50+
make
51+
```
52+
53+
Use ``cmake -G"MSYS Makefiles" .. `` on MSYS2.
1754

18-
Only tested on Linux.
55+
Tested on Linux and MXE/MSYS2 (MinGW).
1956

2057
## Usage
2158

0 commit comments

Comments
 (0)