Fcalva/cyclone
1
0
Fork 0
mirror of https://github.com/justinethier/cyclone.git synced 2025-05-20 14:19:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Justin Ethier 2019-12-12 12:39:19 -05:00 • committed by GitHub
parent e3390f132c
commit 52da937933
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -25,37 +25,38 @@ Features
- Support for Linux, Windows, FreeBSD, and Mac platforms. - Support for Linux, Windows, FreeBSD, and Mac platforms.
- Known to run on x86-64, x86, and Arm (Raspberry Pi) architectures. - Known to run on x86-64, x86, and Arm (Raspberry Pi) architectures.
Getting Started Installation
--------------- ---------------
1. There are several options available for installing Cyclone: There are several options available for installing Cyclone:
### 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**](https://github.com/justinethier/cyclone-bootstrap) to build a set of binaries. Instructions are provided for Linux, Mac, Windows (via MSYS), and FreeBSD 12. 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**](https://github.com/justinethier/cyclone-bootstrap) to build a set of binaries. Instructions are provided for Linux, Mac, Windows (via MSYS), and FreeBSD 12.
### Docker ### Docker
Cyclone can be run from a [Docker Image](https://hub.docker.com/r/cyclonescm/cyclone). Cyclone can be run from a [Docker Image](https://hub.docker.com/r/cyclonescm/cyclone):
For example:
docker run -it cyclonescm/cyclone bash docker run -it cyclonescm/cyclone bash
### Homebrew ### Homebrew
Mac (and Linux!) users wanting to use Homebrew can do the following: Mac (and Linux!) users wanting to use Homebrew can do the following:
- If Homebrew is not already installed: follow the instructions at [https://brew.sh/](https://brew.sh/) to install the homebrew package manager. - If Homebrew is not already installed: follow the instructions at [https://brew.sh/](https://brew.sh/) to install the homebrew package manager.
- `brew tap cyclone-scheme/cyclone` - `brew tap cyclone-scheme/cyclone`
- `brew install cyclone-scheme/cyclone/cyclone-bootstrap` - `brew install cyclone-scheme/cyclone/cyclone-bootstrap`
### Binary Packages ### Binary Packages
Arch Linux users can install using the [AUR](https://aur.archlinux.org/packages/cyclone-scheme/). 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: Getting Started
---------------
After installing you can run the `cyclone` command to compile a single Scheme file:
$ cyclone examples/fac.scm $ cyclone examples/fac.scm
$ examples/fac $ examples/fac
3628800 3628800
And the `icyc` command to start an interactive interpreter: And the `icyc` command to start an interactive interpreter. Note you can use [`rlwrap`](http://linux.die.net/man/1/rlwrap) to make the interpreter more friendly, EG: `rlwrap icyc`:
$ icyc $ icyc
@ -78,9 +79,7 @@ Getting Started
cyclone> (write 'hello-world) cyclone> (write 'hello-world)
hello-world hello-world
You can use [`rlwrap`](http://linux.die.net/man/1/rlwrap) to make the interpreter more friendly, EG: `rlwrap icyc`. Read the documentation below for more information on how to use Cyclone.
3. Read the documentation below for more information on how to use Cyclone.
Documentation Documentation
------------- -------------