Skip to content

Doc cmake update #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,62 @@
### 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
cmake -G "Ninja Multi-Config" -B build
# 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
Expand All @@ -51,6 +67,7 @@
```

Extra: Get JHS Web IDE
```

```sh
./build/jsrc/Debug/jconsole ./jlibrary/addons/ide/jhs/config/jhs.cfg
```