luo980/cpptrace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update contributing instructions

Browse Source
This commit is contained in:
Jeremy 2024-05-03 20:23:33 -05:00
parent 4feeb6dfe2
commit ee572226f7
No known key found for this signature in database
GPG Key ID: 19AA8270105E8EB4
2 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -17,8 +17,13 @@ too much ultimately but consistency within a codebase is important.
## Local development ## Local development
To build the project make a `build/` folder and run `cmake ..`, along with any cmake configurations The easiest way to get started with local development is running `make debug` (which automatically configures cmake and
you desire. Then run `make -j` or `msbuild cpptrace.sln`. builds). Note: This requires ninja at the moment.
For more control over how the library is built you can manually build with cmake:
`cmake ..` in a `build/` folder along with any cmake configurations you desire. Then run `make -j` or `ninja` or
`msbuild cpptrace.sln`.
Some useful configurations: Some useful configurations:
- `-DCMAKE_BUILD_TYPE=Debug|Release|RelWithDebInfo`: Build in debug / release / etc. - `-DCMAKE_BUILD_TYPE=Debug|Release|RelWithDebInfo`: Build in debug / release / etc.

6
README.md
View File

@ -50,6 +50,7 @@ Cpptrace also has a C API, docs [here](docs/c-api.md).
- [Summary of Library Configurations](#summary-of-library-configurations) - [Summary of Library Configurations](#summary-of-library-configurations)
- [Testing Methodology](#testing-methodology) - [Testing Methodology](#testing-methodology)
- [Notes About the Library and Future Work](#notes-about-the-library-and-future-work) - [Notes About the Library and Future Work](#notes-about-the-library-and-future-work)
- [Contributing](#contributing)
- [License](#license) - [License](#license)
# 30-Second Overview # 30-Second Overview
@ -968,6 +969,11 @@ A couple things I'd like to improve in the future:
A couple features I'd like to add in the future: A couple features I'd like to add in the future:
- Tracing other thread's stacks - Tracing other thread's stacks
# Contributing
I'm grateful for the help I've received with this library and I welcome contributions! For information on contributing
please refer to [CONTRIBUTING.md](./CONTRIBUTING.md).
# License # License
This library is under the MIT license. This library is under the MIT license.