From 98f8529cae71cc75a34543bcddafc0226f78c183 Mon Sep 17 00:00:00 2001 From: Justin Ethier Date: Thu, 18 Apr 2019 17:23:51 -0400 Subject: [PATCH] Sync recent changes to readme --- index.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/index.md b/index.md index 16fd5c81..6982bfbd 100644 --- a/index.md +++ b/index.md @@ -5,7 +5,7 @@ id: index ghproj: "http://github.com/justinethier/cyclone/tree/master/" --- -Cyclone is a brand-new Scheme-to-C compiler that allows practical development of applications using R7RS Scheme. [Cheney on the MTA](https://github.com/justinethier/cyclone/raw/master/docs/research-papers/CheneyMTA.pdf) is used by the runtime to implement full tail recursion, continuations, and generational garbage collection. In addition, the Cheney on the MTA concept has been extended to allow execution of multiple native threads. An on-the-fly garbage collector is used to manage the second-generation heap and perform major collections without "stopping the world". +Cyclone is a brand-new Scheme-to-C compiler that allows practical application development using R7RS Scheme. [Cheney on the MTA](https://github.com/justinethier/cyclone/raw/master/docs/research-papers/CheneyMTA.pdf) is used by Cyclone's runtime to implement full tail recursion, continuations, and generational garbage collection. In addition, the Cheney on the MTA concept has been extended to allow execution of multiple native threads. An on-the-fly garbage collector is used to manage the second-generation heap and perform major collections without "stopping the world". Cyclone is the first compiler written entirely in the latest R7RS Scheme language standard, and the intent is to support as much of that language as possible. @@ -29,7 +29,14 @@ Features Getting Started --------------- -1. To install Cyclone on your machine for the first time use [**cyclone-bootstrap**](https://github.com/justinethier/cyclone-bootstrap) to build a set of binaries. Instructions are provided for Linux, Mac, and Windows (via MSYS). +1. To install Cyclone on your machine for the first time on Linux and Windows, and for Mac users wanting to install without using Homebrew, use [**cyclone-bootstrap**](https://github.com/justinethier/cyclone-bootstrap) to build a set of binaries. Instructions are provided for Linux, Mac, and Windows (via MSYS). + + Mac users wanting to use Homebrew can do the following: + - If Homebrew is not already installed: follow the instructions at https://brew.sh/ to install the homebrew package manager. + - brew tap cyclone-scheme/cyclone + - brew install cyclone-scheme/cyclone/cyclone + + Arch Linux users can install using the AUR: https://aur.archlinux.org/packages/cyclone-scheme/ 2. After installing you can run the `cyclone` command to compile a single Scheme file: @@ -45,13 +52,13 @@ Getting Started @@@ @@@@: `@@@@@+ - .@@@+@@@ Cyclone - @@ @@ An experimental Scheme compiler - ,@ https://github.com/justinethier/cyclone + .@@@+@@@ + @@ @@ Cyclone Scheme->C compiler + ,@ http://justinethier.github.io/cyclone/ '@ .@ - @@ #@ (c) 2014 Justin Ethier - `@@@#@@@. Version 0.0.1 (Pre-release) + @@ #@ (c) 2014-2019 Justin Ethier + `@@@#@@@. Version 0.11 #@@@@@ +@@@+ @@# @@ -98,3 +105,4 @@ Compiler Internals - There is a [Development Guide](docs/Development) with instructions for common tasks when hacking on the compiler itself. - Cyclone's [Garbage Collector](docs/Garbage-Collector) 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. +