Merge pull request #1 from Croydon/readme

Update readme, .gitignore and add .gitattributes
master
T7g 2020-09-28 04:48:19 -04:00 committed by GitHub
commit 6018f6b6c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 4 deletions

12
.gitattributes vendored 100644
View File

@ -0,0 +1,12 @@
*.py text eol=lf
*.yml text eol=lf
*.diff text eol=lf
*.conf text eol=lf
*.md text eol=lf
*.cc text eol=lf
*.hh text eol=lf
*.txt text eol=lf
*.build text eol=lf
*.gitattributes text eol=lf
*.gitignores text eol=lf
*.wrap text eol=lf

3
.gitignore vendored
View File

@ -2,3 +2,6 @@ subprojects/libostd
*.o
*.core
*.so
build/
.idea/
.vscode/

View File

@ -72,14 +72,23 @@ utilized in the outside native code.
The only dependency is libostd:
https://git.octaforge.org/tools/libostd.git/
https://git.octaforge.org/OctaForge/libostd
https://github.com/OctaForge/libostd
If libostd can work on your system, so can libcubescript.
The supplied Makefile builds a static library on Unix-like OSes. Link this
library together with your application and everything should just work. It also
builds the REPL.
Libostd is built using Meson. Therefore, you need to install Meson and then
you can compile it as usual. Typically, this will be something like
~~~
mkdir build && cd build
meson ..
meson compile
~~~
Link the libcubescript library together with your application and everything should just work.
It also builds the REPL.
The project also bundles the linenoise line editing library which has been modified
to compile cleanly as C++ (with the same flags as libcubescript). It's used strictly