Fcalva/cyclone
1
0
Fork 0
mirror of https://github.com/justinethier/cyclone.git synced 2025-05-21 22:59:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Added additional installation instructions
This commit is contained in:
Justin Ethier 2019-12-12 12:22:04 -05:00 • committed by GitHub
parent aa024952b3
commit e3390f132c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -28,13 +28,25 @@ Features
Getting Started Getting Started
--------------- ---------------
1. 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. 1. There are several options available for installing Cyclone:
Mac users wanting to use Homebrew can do the following: ### 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.
### Docker
Cyclone can be run from a [Docker Image](https://hub.docker.com/r/cyclonescm/cyclone).
For example:
docker run -it cyclonescm/cyclone bash
### Homebrew
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
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: 2. After installing you can run the `cyclone` command to compile a single Scheme file: