-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(docs) updated the QuickStart
README
- Loading branch information
1 parent
39002eb
commit 76c26a9
Showing
1 changed file
with
13 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |