You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/prologue/building.md
+19-6Lines changed: 19 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ You can choose to build the project from source (which requires some knowledge l
24
24
*This step is optional*
25
25
26
26
1. You can create an environment variable `ARKSCRIPT_PATH`, with the path to the installation directory of ArkScript, so that the standard library can be located without using `--lib <path>`.
27
-
The environment variable should direct to a folder with the folder `lib/` inside. Multiple path can be provided if your installation separates the modules and the standard library, by separating the different paths with a single `;`.
27
+
The environment variable should direct to a folder with the folder `std/` inside. Multiple path can be provided if your installation separates the modules and the standard library, by separating the different paths with a single `;`.
28
28
2. You can create an environment variable `ARKSCRIPT_REPL_STARTUP`, with the path to a single `.ark` file that will be loaded each time you use the REPL. Useful to preload your favorite libraries!
29
29
30
30
## Installing from a release
@@ -112,8 +112,11 @@ Commands:
112
112
```shell
113
113
cmake . -Bbuild -DARK_BUILD_EXE=On
114
114
cmake --build build --config Release
115
+
115
116
# needs administrator rights to install under /usr/bin
116
117
sudo cmake --install build --config Release
118
+
# OR install under a custom directory (it must exists, cmake won't create it)
To check that everything works, it is important to run the tests for the projects, and we have a multitude of them:
179
+
To check that everything works, it is important to run the tests for the project. They can be compiled using `-DARK_TESTS`, building a `unittests` executable.
180
+
181
+
The kind of tests we have:
169
182
-`tests/benchmarks`: benchmarks for the parser and VM with a few scripts to help identifying regressions
170
183
-`tests/fuzzing`: a collection of scripts (in `tests/fuzzing/docker/`) and ArkScript source files under the different `corpus` / `corpus-cmin` / `corpus-cmin-tmin` directories (only the `corpus` directory is managed by us, the two others are generated automatically through scripts and AFL++). Fuzzers can be run automatically using the `start-afl-docker.sh` script, that starts a docker image, compile ArkScript and run the fuzzers inside tmux sessions. An `output/` folder is created at the root of the project with the fuzzers output
171
184
-`tests/repl`: a short test for the REPL to ensure it still autocompletes correctly
Copy file name to clipboardExpand all lines: content/docs/prologue/getting_started.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,6 +78,6 @@ Everyone is welcome to contribute to the project, as long as you are respectful
78
78
79
79
## Using ArkScript in your company
80
80
81
-
I (Lex Plateau) am working pretty much alone on this project, and I try to do my best to leave it as bug free and as performant as possible. However, this is a side project forwhich I'm currently **not paid** to work on, thus I can't fix every bug or address every feature requestin a timely manner.
81
+
I (Lexy Plateau) am working pretty much alone on this project, and I try to do my best to leave it as bug free and as performant as possible. However, this is a side project forwhich I'm currently **not paid** to work on, thus I can't fix every bug or address every feature requestin a timely manner.
82
82
83
83
Please reach out either by email (lexplt.dev@gmail.com) or via a [discussion](https://github.com/orgs/ArkScript-lang/discussions) before using the language in a company project, so that we can set up a support contract. If you don't want to set up a contract, your issues and support requests won't be prioritized (and possibly left unanswered).
0 commit comments