summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorNakidai <plaza521@inbox.ru>2024-07-06 16:49:05 +0300
committerNakidai <plaza521@inbox.ru>2024-07-06 16:49:05 +0300
commitcea648180f5218dfe0e8c0038d9bb6535e2eefcd (patch)
treeec9202a841a24cfd1a0df962b8fe8d934ef25329 /README.md
parentd619f81b834c7f1816963e5ebd65cc52a5f613c4 (diff)
download3cl-cea648180f5218dfe0e8c0038d9bb6535e2eefcd.tar.gz
3cl-cea648180f5218dfe0e8c0038d9bb6535e2eefcd.zip
Add "How to build" section in the README.md
For people who can't or don't know how to do it
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index f492dff..c22bef2 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,22 @@ To write code for it, follow [this documentation](https://github.com/holy-8/cool
 
 Also there're [examples](https://github.com/holy-8/cool_char_lang/tree/main/programs)
 
+How to build
+--
+If you don't know how to build cmake projects, then you should google a little
+about it, but in short you need to install (obviously) cmake, some working c
+compiler and run these commands in the root of the project:
+```
+cmake -B build
+cmake --build build
+```
+
+And `3cl` (or `3cl.exe` ig if you're on windows) will appear in the `build`
+directory
+
+Also I think you can use some wrapper of the cmake with gui (or iirc cmake has
+its own gui app)
+
 Dependencies
 --
 - [cvector](https://github.com/eteran/c-vector) (header only, so included in the source)