Cyclone Scheme  0.20
README
Cyclone Scheme

Cyclone Scheme is a brand-new compiler that allows real-world application development using the R7RS Scheme Language standard. We provide modern features and a stable system capable of generating fast native binaries.

Cheney on the MTA 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".

Features

Installation

There are several options available for installing Cyclone:

Docker

Docker

Cyclone can be run from a Docker Image:

docker run -it cyclonescm/cyclone bash

Homebrew

Homebrew

Mac (and Linux!) users wanting to use Homebrew can do the following.

Note 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-bootstrap

Arch Linux

Arch Linux

Arch Linux users can install using the AUR:

git clone https://aur.archlinux.org/cyclone-scheme.git
cd cyclone-scheme
makepkg -si

Build from Source

Build from Source

To install Cyclone on your machine for the first time on Linux, Windows, FreeBSD, and for Mac users wanting to install without using Homebrew, use cyclone-bootstrap to build a set of binaries. Instructions are provided for Linux, Mac, Windows (via MSYS), and FreeBSD 12.

Getting Started

After installing you can run the cyclone command to compile a single Scheme file:

$ cyclone examples/fac.scm
$ examples/fac
3628800

And the icyc command to start an interactive interpreter. Note you can use rlwrap to make the interpreter more friendly, EG: rlwrap icyc:

$ icyc

              :@
            @@@
          @@@@:
        `@@@@@+
       .@@@+@@@      
       @@     @@     Cyclone Scheme->C compiler
      ,@             http://justinethier.github.io/cyclone/
      '@
      .@
       @@     #@     (c) 2014-2019 Justin Ethier
       `@@@#@@@.     Version 0.11
        #@@@@@
        +@@@+
        @@#
      `@.

cyclone> (write 'hello-world)
hello-world

Read the documentation below for more information on how to use Cyclone.

Package Manager

Cyclone Winds

The cyclone-winds package manager provides the ability to install packaged libraries and programs for Cyclone. See the cyclone-winds site for more information.

The Cyclone-Winds wiki contains a full list of packages with documentation.

Documentation

Example Programs

Cyclone provides several example programs, including:

Compiler Internals

License

Copyright (C) 2014 Justin Ethier.

Cyclone is available under the MIT license.