diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9711c9f9..62b07aa7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,23 @@ -### Getting Started & Building: +# Getting Started & Building + 1. Prerequisites: - * CMake version 3.17.0+ -> Ubuntu systems seem to have a problem getting the latest version, please build from sources or use another package such as snap. - * [Ubuntu CMake update instructions](https://apt.kitware.com/) + * CMake version 3.18.0+ + * Ubuntu systems may have a problem getting the latest cmake version + * [Ubuntu CMake update instructions](https://apt.kitware.com/) * Ninja * Additional prerequisites for building the documentation: * python packages: sphinx, breathe, divio-docs-theme * doxygen 2. Checkout the repository: + ```sh # --recursive flag is needed to pull in the submodule git clone https://github.com/codereport/jsource.git --recursive ``` + 3. Build jconsole: * Run cmake: + ```sh cd jsource mkdir build @@ -20,27 +25,38 @@ # If you want documentation built, modify your cmake command to: cmake -G "Ninja Multi-Config" -B build -DDOCS:STRING=YES ``` + * To build debug: + ```sh ninja -C build ``` + * To build release: + ```sh ninja -C build -f build-Release.ninja ``` + 4. Run jconsole: * To run the debug build: + ```sh ./build/jsrc/Debug/jconsole ``` + * To run the release build: + ```sh ./build/jsrc/Release/jconsole ``` + 5. Run tests: + ```sh ninja -C build test ``` + * Filter tests: ```sh @@ -51,6 +67,7 @@ ``` Extra: Get JHS Web IDE -``` + +```sh ./build/jsrc/Debug/jconsole ./jlibrary/addons/ide/jhs/config/jhs.cfg ```