Skip to content

Commit

Permalink
Now it's working!
Browse files Browse the repository at this point in the history
  • Loading branch information
Borja Lorente committed Apr 13, 2017
1 parent fccd137 commit 48e900e
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 21 deletions.
15 changes: 2 additions & 13 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -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
53 changes: 46 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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`) `<path>`: Open the file in `<path>`, execute it, and show the resulting environment.

- `exec`(or `e`) `<code>`: Execute the code and show the resulting environment.

- `print` (or `p`) `<expression>`: 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.<br>
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.<br>
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 ([email protected]) if you want some direction on where to begin.

## Compilation instructions

Naylang uses standard out-of-source compilation with CMake.<br>
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
```
1 change: 0 additions & 1 deletion thirdparty/syntax-highlighting/Grace.tmbundle
Submodule Grace.tmbundle deleted from fa30c1

0 comments on commit 48e900e

Please sign in to comment.