Skip to content

Commit

Permalink
(docs) updated the QuickStart README
Browse files Browse the repository at this point in the history
  • Loading branch information
amkrajewski committed Feb 29, 2024
1 parent 39002eb commit 76c26a9
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# Quick Start

This is a quick start guide to get you up and running with the nimCSO software. If you are running it in the Codespaces environment, you should now open the
[**`quickstart.ipynb`**](quickstart.ipynb) notebook inside this directory and follow the instructions there. **Please note, once propted to select a kernel (after running the first code cell), you should select the `base` kernel (which should show up as recommended).**
This is a quick start guide to get you up and running with the nimCSO software. **If you are running it in the Codespaces environment, everything is prepared for you**, and you should now open the [**`quickstart.ipynb`**](quickstart.ipynb) notebook inside this directory and follow the instructions there. *Please note, that once prompted to select a kernel (after running the first code cell), you should select the `base` kernel (which should show up as recommended).*

Alternatively, if you want to start playing with the CLI directly, you can compile the tool using the command below. It will use the default `config.yaml` file pointing to the `dataList.txt` and should take just a few seconds.

nim c -r -f -d:release src/nimcso

Once the above is run, you will see the `help` printout showing you your options. You can either add them on top of the previous command, which will recompile the tool, like

nim c -r -f -d:release src/nimcso --geneticSearch

or use the already compiled runtime

./src/nimcso.out -gs

0 comments on commit 76c26a9

Please sign in to comment.