From 48e900ef645df97e2cf87f84b8640311a70bd808 Mon Sep 17 00:00:00 2001 From: Borja Lorente Date: Thu, 13 Apr 2017 16:27:00 -0700 Subject: [PATCH] Now it's working! --- docs/_config.yml | 15 +----- docs/index.md | 53 ++++++++++++++++--- thirdparty/syntax-highlighting/Grace.tmbundle | 1 - 3 files changed, 48 insertions(+), 21 deletions(-) delete mode 160000 thirdparty/syntax-highlighting/Grace.tmbundle diff --git a/docs/_config.yml b/docs/_config.yml index 33f506e..0636009 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,14 +1,3 @@ +theme: jekyll-theme-merlot -## What? - - -Naylang is the new interpreter, runtime and debugger for a subset of the [Grace Programming Language](http://gracelang.org/applications/). -It's still a work in progress, but it has some great features already! - -## How? - -To use Naylang, just download the executable for the [latest release](https://github.com/blorente/naylang/releases) and start it up in a terminal! - -If you'd rather compile it from source [click me!](#compilation-instructions) - - +show-downloads: true diff --git a/docs/index.md b/docs/index.md index 33f506e..fa7f1cd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,53 @@ +# What? -## What? - +Naylang is the new interpreter, runtime and debugger for a subset of the [Grace Programming Language](http://gracelang.org/applications/). It's still a work in progress, but it has some great features already! -Naylang is the new interpreter, runtime and debugger for a subset of the [Grace Programming Language](http://gracelang.org/applications/). -It's still a work in progress, but it has some great features already! - -## How? +# How? To use Naylang, just download the executable for the [latest release](https://github.com/blorente/naylang/releases) and start it up in a terminal! If you'd rather compile it from source [click me!](#compilation-instructions) - +## Commands + +For now, Naylang accepts three kinds of commands: + +- `load` (or `l`) ``: Open the file in ``, execute it, and show the resulting environment. + +- `exec`(or `e`) ``: Execute the code and show the resulting environment. + +- `print` (or `p`) ``: Execute the expression and show the result. + +Here's an example execution of Naylang: + +[![asciicast](https://asciinema.org/a/eqkmros19kzugc2fy96wo8u12.png)](https://asciinema.org/a/eqkmros19kzugc2fy96wo8u12) + +# Want to contribute? + +Naylang is written entirely in modern C++14.
+It uses [ANTLR4](https://antlr.org) for parsing, [CMake](https://cmake.org/) as a build system and [Catch](https://github.com/philsquared/Catch) as a testing framework. + +If you'd like to contribute to this project, you are more than welcome to.
+Feel free to [submit an issue](https://github.com/blorente/naylang/issues/new), + +fork the [main repo](https://github.com/blorente/naylang) and submit a pull request with your improvements, or even shoot me an email (blorente@ucm.es) if you want some direction on where to begin. + +## Compilation instructions + +Naylang uses standard out-of-source compilation with CMake.
+It requires at least version 3 of CMake and a compiler that supports C++14 (for example, GCC6.x). + +When all those dependencies are installed, just download the repo (`git clone https://github.com/blorente/naylang`) and a simple sequence of commands should suffice to run the tests: + +``` +cd /root/of/repo +mkdir +build && cd build +cmake .. +make -j antlr4cpp antlr4cpp_generation_naylang +cmake .. +make -j +cd tests +chmod +x ./tests +./tests +``` diff --git a/thirdparty/syntax-highlighting/Grace.tmbundle b/thirdparty/syntax-highlighting/Grace.tmbundle deleted file mode 160000 index fa30c17..0000000 --- a/thirdparty/syntax-highlighting/Grace.tmbundle +++ /dev/null @@ -1 +0,0 @@ -Subproject commit fa30c175f7862fce7458284e01561e8f330993c6