|
|
@@ -1,14 +1,21 @@
|
|
|
# Readme
|
|
|
For a tutorial/documentation on the commands open [/readme/commands.html](/docs/readme.md)
|
|
|
+Once downloads are ready, you'll be able to find them in the [releases](https://github.com/Zeda/Grammer2/releases) section.
|
|
|
|
|
|
-# Building
|
|
|
+Before going on, I do want to thank nonstickatom. I had to delete the commit history because I was misusing `git`, and that
|
|
|
+has unfortunately removed the logs of many of nonstickatom's contributions to the project (especially in documentation).
|
|
|
|
|
|
-Binaries are available in the `/bin` folder, but for developers, building from source might be useful.
|
|
|
+# Building
|
|
|
+If you want to build this project yourself, you'll first need to clone the repository:
|
|
|
+```
|
|
|
+git clone --recursive-submodules https://github.com/Zeda/Grammer2.git
|
|
|
+```
|
|
|
|
|
|
This project uses [`spasm-ng`](https://github.com/alberthdev/spasm-ng) to compile, and I use Linux. On windows you can either use the [`linux subsytem`](https://www.windowscentral.com/install-windows-subsystem-linux-windows-10)(only on windows 10) and install spasm from there or you can download the [`spasm-ng`](https://github.com/alberthdev/spasm-ng/releases) for Windows release.
|
|
|
|
|
|
***NOTE:** at the time of this writing, it appears that spasm-ng has a bug that doesn't parse the name field correctly.
|
|
|
-Please use this version for now: https://github.com/alberthdev/spasm-ng/tree/feature/app-name-var-size.*
|
|
|
+Please use this version for now: https://github.com/alberthdev/spasm-ng/tree/feature/app-name-var-size. If you are on
|
|
|
+Windows, Nonstickatom has built an .exe for it and posted [here]() with permission.*
|
|
|
|
|
|
## Linux:
|
|
|
From the command line, run `./compile`
|
Zeda Thomas