Skip to content

Commit 64b6293

Browse files
author
Borja Lorente
committed
mend
1 parent b20d788 commit 64b6293

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/index.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ An interpreter and debugger for the Grace programming language
33

44
## What?
55
Naylang is the new interpreter, runtime and debugger for a subset of the [Grace Programming Language](http://gracelang.org/applications/).
6-
It's still a work in progress, but it has some great capabilites already!
6+
It's still a work in progress, but it has some great features already!
77

88
## How?
99

1010
To use Naylang, just download the executable for the [latest release](https://github.com/blorente/naylang/releases) and start it up in a terminal!
1111

12-
If you'd rather compile it from source [click me!](#Compilation instructions)
12+
If you'd rather compile it from source [click me!](#compilation-instructions)
1313

1414
### Commands
1515

@@ -25,13 +25,21 @@ Here's an example execution of Naylang:
2525

2626
## Want to contribute?
2727

28-
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.
28+
Naylang is written entirely in modern C++14.
29+
It uses [ANTLR4](https://antlr.org) for parsing, [CMake](https://cmake.org/)
30+
as a build system and [Catch](https://github.com/philsquared/Catch) as a testing framework.
2931

30-
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.
32+
If you'd like to contribute to this project, you are more than welcome to.
33+
Feel free to [submit an issue](https://github.com/blorente/naylang/issues/new),
34+
fork the [main repo](https://github.com/blorente/naylang) and submit a pull request with your improvements,
35+
or even shoot me an email (blorente@ucm.es) if you want some direction on where to begin.
3136

3237
### Compilation instructions
33-
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).
34-
When all the dependencies are installed, and the repo is downloaded, a simple sequence of commands should suffice to run the tests:
38+
Naylang uses standard out-of-source compilation with CMake.
39+
It requires at least version 3 of CMake and a compiler that supports C++14 (for example, GCC6.x).
40+
41+
When all those dependencies are installed, just download the repo (`git clone https://github.com/blorente/naylang`) and
42+
a simple sequence of commands should suffice to run the tests:
3543

3644
```
3745
cd /root/of/repo

0 commit comments

Comments
 (0)