Skip to content

Commit

Permalink
Update documentation with new installation instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
emina committed Mar 24, 2016
1 parent 575c8d0 commit e952f46
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 20 deletions.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,41 @@
The Rosette Language
====================

[![Build Status](https://travis-ci.org/emina/rosette.svg?branch=refactor-ops)](https://travis-ci.org/emina/rosette)
[![Build Status](https://travis-ci.org/emina/rosette.svg?branch=master)](https://travis-ci.org/emina/rosette)

This repository includes the source code for the Rosette solver-aided host language, as well as several example
solver-aided DSLs.

## Installing Rosette

The easiest way to install Rosette is from Racket's package manager:

* Download and install Racket 6.4 from http://racket-lang.org

* Use Racket's `raco` tool to install Rosette:

`$ raco pkg install rosette`

### Installing from source

Alternatively, you can install Rosette from source:

* Download and install Racket 6.4 from http://racket-lang.org

* Clone the rosette repository:

`$ git clone https://github.com/emina/rosette.git`

* Uninstall any previous versions of Rosette:

`$ raco pkg remove rosette`

* Use Racket's `raco` tool to install Rosette as one of your Racket collections:

`$ cd rosette`
`$ raco link rosette`
`$ raco setup -l rosette`

* Create a `bin` subdirectory in the `rosette` directory:

`$ mkdir bin`
`$ ls`
`bin doc rosette sdsl test LICENSE README.md`

* Download or build a copy of the [Z3](https://github.com/Z3Prover/z3) solver, version 4.4.2.

* Copy the `z3` executable (with no filename extension) to the `rosette/bin` directory.


## Executing Rosette programs

* Open the target program in DrRacket (e.g., [`rosette/sdsl/fsm/demo.rkt`](https://github.com/emina/rosette/blob/master/sdsl/fsm/demo.rkt))
Expand Down Expand Up @@ -71,3 +77,7 @@ solver-aided DSLs.

[1]: http://emina.github.io/rosette/doc/rosette-guide/index.html
[2]: http://dl.acm.org/citation.cfm?id=2594340




9 changes: 1 addition & 8 deletions rosette/doc/guide/scribble/welcome/welcome.scrbl
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,12 @@ The name "Rosette" refers both to the language and the whole system.

@section[#:tag "sec:get"]{Installing Rosette}

Rosette is built on top of Racket, and it ships with a Java-based solver.
To install Rosette, you will need to

@itemlist[@item{Download and install @hyperlink["http://racket-lang.org"]{Racket} (version 6.4).}
@item{Obtain the Rosette source code from GitHub:
@nested{
@verbatim|{> git clone https://github.com/emina/rosette.git}|}}
@item{Use Racket's @tt{raco} tool to install Rosette:
@nested{
@verbatim|{> cd rosette
> git submodule init
> git submodule update
> raco pkg install ./rosette}|}}]
@verbatim|{> raco pkg install rosette}|}}]

@section[#:tag "sec:run"]{Interacting with Rosette}

Expand Down

0 comments on commit e952f46

Please sign in to comment.