diff --git a/README.md b/README.md index 0db2c546..ee011c2c 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Cyclone is a brand-new Scheme-to-C compiler that allows practical application de Cyclone is the first compiler written entirely in the latest R7RS Scheme language standard, with the intent to support as much of that language as possible. +This [benchmarks](http://ecraven.github.io/r7rs-benchmarks/benchmark.html) page by [ecraven](https://github.com/ecraven) compares the performance of Cyclone with other Schemes. + Getting Started --------------- @@ -47,15 +49,7 @@ Documentation - The [User Manual](docs/User-Manual.md) covers in detail how to use Cyclone, and provides information and API documentation on the Scheme language features implemented by Cyclone. -- [Writing the Cyclone Scheme Compiler](docs/Writing-the-Cyclone-Scheme-Compiler-Revised-2017.md) provides high-level details on how the compiler was written and how it works. - -- There is a [Development Guide](docs/Development.md) with instructions for common tasks when hacking on the compiler itself. - -- Cyclone's [Garbage Collector](docs/Garbage-Collector.md) is documented at a high-level. This document includes details on extending Cheney on the MTA to support multiple stacks and fusing that approach with a tri-color marking collector. - -- This [Benchmarks](http://ecraven.github.io/r7rs-benchmarks/benchmark.html) page by [ecraven](https://github.com/ecraven) compares the performance of Cyclone with other R7RS and R6RS Schemes using a common set of benchmarks. - -- Finally, if you need another resource to start learning the Scheme language you may want to try a classic textbook such as [Structure and Interpretation of Computer Programs](https://mitpress.mit.edu/sicp/full-text/book/book.html). +- If you need a resource to start learning the Scheme language you may want to try a classic textbook such as [Structure and Interpretation of Computer Programs](https://mitpress.mit.edu/sicp/full-text/book/book.html). Example Programs ---------------- @@ -72,6 +66,15 @@ Cyclone provides several example programs, including: - Finally, the largest program is the compiler itself. Most of the code is contained in a series of libraries which are used by [`cyclone.scm`](cyclone.scm) and [`icyc.scm`](icyc.scm) to create executables for Cyclone's compiler and interpreter. +Compiler Internals +------------------ + +- [Writing the Cyclone Scheme Compiler](docs/Writing-the-Cyclone-Scheme-Compiler-Revised-2017.md) provides high-level details on how the compiler was written and how it works. + +- There is a [Development Guide](docs/Development.md) with instructions for common tasks when hacking on the compiler itself. + +- Cyclone's [Garbage Collector](docs/Garbage-Collector.md) is documented at a high-level. This document includes details on extending Cheney on the MTA to support multiple stacks and fusing that approach with a tri-color marking collector. + License ------- Copyright (C) 2014 [Justin Ethier](http://github.com/justinethier).