Fixed table of contents in README.md

Still wasn't right in the previous commit. Hopefully this does the
trick. Cgit uses md2html which internally uses the original
implementation of markdown from
http://daringfireball.net/projects/markdown/

Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
This commit is contained in:
Collin J. Doering 2015-06-18 15:40:14 -04:00
parent 1bffc4c622
commit 9cd0fe8b33
1 changed files with 15 additions and 15 deletions

View File

@ -1,28 +1,28 @@
# Hack Assembler in Haskell
* [Introduction][introduction]
* [Building][building]
* [Usage][usage]
* [Tools][tools]
* [License][license]
* [Issues][issues]
* [Related Projects][related-projects]
* [Introduction](#introduction)
* [Building](#building)
* [Usage](#usage)
* [Tools](#tools)
* [License](#license)
* [Issues](#issues)
* [Related Projects](#related-projects)
## Introduction
## Introduction <a name="introduction"></a>
`Asmblr` is a small Haskell program that transforms *Hack Assembly* into its machine language
representation. The parser itself is made available though the library `hackasm` and can be
included in other projects. To see its documentation run `cabal haddock` and view the
documentation in `dist/doc`.
## Features
## Features <a name="features"></a>
* Follows a similar structure to the implementation describe by the *Nand to Tetris* book
* Faster then the implementation given with the *Nand to Tetris* course
* Can read from stdin and write to stdout (if requested)
* Uses open-source tools wherever possible
## Building
## Building <a name="building"></a>
`Asmblr` requires GHC and cabal to be built and can be done like so:
@ -34,7 +34,7 @@ using you shell or cabal (via the command `cabal run Asmblr`). The `Asmblr` prog
installed using `cabal install`. For more information on installing cabal packages and using
cabal see [its manual](https://www.haskell.org/cabal/users-guide/).
## Usage
## Usage <a name="usage"></a>
This project comes with the directory `doc/examples` that contains example *Hack Assembly*
programs used for testing the assembler. To clarify how to run the `Asmblr` binary once built
@ -60,7 +60,7 @@ convenience the output of `Asmblr --help` is provided below.
-h --help show program usage
-o[FILE] --output[=FILE] output file or '-' for stdout
## Tools
## Tools <a name="tools"></a>
The creation of this software was made possible by the following open source tools and
libraries.
@ -69,11 +69,11 @@ libraries.
* [GHC][], for compilation of Haskell code
* [Cabal][], for building the project
## License
## License <a name="license"></a>
This project is licensed under the [GPLv3][]. Please see the [LICENSE](../tree/LICENSE) file for full details.
## Issues
## Issues <a name="issues"></a>
There are some minor issues that can be cleaned up in future releases. Namely, making error
output more human readable, and a few minor optimization's.
@ -87,7 +87,7 @@ output more human readable, and a few minor optimization's.
for optimization's sake
* Write tests so that future changes don't break things (see folder `testsuite`)
## Related Projects
## Related Projects <a name="related-projects"></a>
The *Hack Machine Code* generated by this assembler is only useful if a *Hack* machine or
simulator is available. One such simulator is available with the *Nand to Tetris* course.