Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.33 KB

DEVELOPMENT.md

File metadata and controls

41 lines (25 loc) · 1.33 KB

Great to have you here! Here are a few ways you can help out with Nelson.

Where should I start?

Your first commits

If you are interested in contributing to Nelson, that's awesome! We love your help. If you have any questions after reading this page, please feel free to contact Nelson. I will be happy to provide help working through your first bug fix or thinking through the problem you are trying to resolve.

How you can help

We track bugs and features so that anyone who wants to help can start with something that's not too overwhelming. We can absolutely use your help, no matter what level of programming skill you have at the moment.

Development setup

How to build Nelson ?

see BUILDING.md for detailed information.

Indent C/C++ code

  • easy way, available on all platforms:
nvm use
npm i
npm run prettier:clang-format
  • on Macos X and Linux, you need to install clang-format > 3.8. On root directory:
make clang-format

Indentation uses webkit coding style see .clang-format

  • How to debug on macOs and Linux

Edit line 58 of main CMakeLists.txt and replaces Release by Debug. Build nelson and launch with gdb.