add small installing section
Getty Ritter
2 years ago
| 3 | 3 | The `telml` command-line program is the easiest way to use `telml` for your purposes. This allows you to convert a document from `telml` to HTML quickly. It also allows you to create new tags by implementing them in the Lua programming language, to easily create a richer document. |
| 4 | 4 | |
| 5 | 5 | For documentation on the TeLML language itself, see [the data format documentation](https://github.com/aisamanra/telml/blob/master/telml/README.md). |
| 6 | ||
| 7 | ## Installing | |
| 8 | ||
| 9 | Right now the only way to get `telml` is from source. To build and install it, use `cabal install`. It also requires you to have a copy of Lua version 54 on your system. | |
| 10 | ||
| 11 | ``` | |
| 12 | $ git clone https://github.com/aisamanra/telml.git | |
| 13 | $ cd telml | |
| 14 | $ cabal install telml-bin | |
| 15 | ``` | |
| 6 | 16 | |
| 7 | 17 | ## Simple usage |
| 8 | 18 |