Skip to content

Commit

Permalink
Updates to site documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mfikes committed Feb 4, 2017
1 parent 1e474cb commit 683bc29
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 25 deletions.
2 changes: 1 addition & 1 deletion planck-c/globals.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Global variables used throughout Planck

#define PLANCK_VERSION "2.0.0-rc.1"
#define PLANCK_VERSION "2.0.0"

#define EXIT_SUCCESS_INTERNAL -257

Expand Down
8 changes: 3 additions & 5 deletions site/src/intro.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
## Intro

<img width="100" align="right" style="margin: 0ex 1em" src="img/intro.png">
Planck is a stand-alone ClojureScript REPL for macOS.
Planck is a stand-alone ClojureScript REPL for macOS and Linux.

Planck lauches instantly, providing a full-featured REPL environment that is great for experimenting with and learning the ClojureScript language.
Planck launches instantly, providing a full-featured REPL environment that is great for experimenting with and learning the ClojureScript language.

Planck is also great for creating scripts in ClojureScript, providing an alternative to Bash for automating tasks.


> Planck is not a ClojureScript compiler—it does not emit JavaScript for use with web browsers or other execution environments. For targeting those systems, the ClojureScript [compiler](http://clojurescript.org) along with REPLs like [Figwheel](https://github.com/bhauman/lein-figwheel) are useful.
> If you are running Linux, Windows, or macOS, also be sure to check out [Lumo](https://github.com/anmonteiro/lumo), a stand-alone ClojureScript REPL based on Node.js and V8 that is capable of using NPM libraries.
> If you are running Linux, you can run the [Planck 2.0 alpha](https://github.com/mfikes/planck#planck-20-alpha).
> If you are running Windows, Linux, or macOS, also be sure to check out [Lumo](https://github.com/anmonteiro/lumo), a stand-alone ClojureScript REPL based on Node.js and V8 that is capable of using NPM libraries.
2 changes: 1 addition & 1 deletion site/src/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The caching mechanism works whether your are running `planck` to execute a scrip
Planck uses a (naïve) file timestamp mechanism to know if cache files are stale, and it additionally looks at comments like the following

```
// Compiled by ClojureScript 1.9.229 {:static-fns true, :elide-asserts true}
// Compiled by ClojureScript 1.9.456 {:static-fns true, :elide-asserts true}
```

in the compiled JavaScript to see if the files are applicable. If a file can’t be used, it is replaced with an updated copy.
Expand Down
4 changes: 2 additions & 2 deletions site/src/repl.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ If you don't provide any `-i` or `-e` options or args to `planck` when launching

```
$ planck
Planck 1.17
ClojureScript 1.9.229
Planck 2.0.0
ClojureScript 1.9.456
Docs: (doc function-name-here)
(find-doc "part-of-name-here")
Source: (source function-name-here)
Expand Down
23 changes: 7 additions & 16 deletions site/src/setup.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,20 @@
## Setup

<img width="100" align="right" style="margin: 0ex 1em" src="img/setup.jpg">
Planck runs on macOS.
Planck runs on macOS and Linux.

Planck requires no external dependencies. (There is no need for either the Java JVM or Node.js.)

### Homebrew

#### Install

The easiest way to install Planck is via [Homebrew](http://brew.sh):
The easiest way to install Planck on macOS is via [Homebrew](http://brew.sh):

```sh
$ brew install planck
```

#### Update

If you already have Planck installed via Homebrew and you'd like to update to the latest version:

```
$ brew update
$ brew upgrade planck
```

#### Install Master

If you'd like to use Homebrew to install the latest unreleased version of Planck (directly from master in the GitHub repository), you can do the following:
Expand All @@ -33,15 +24,15 @@ $ brew remove planck
$ brew install --HEAD planck
```

### Manual Download and Install
#### Building

You can download Planck. It ships as a single-file binary, so it is as easy as putting it in your path then making it executable:
To build Planck on Linux or macOS, get a copy of the source tree, install the [needed dependencies](https://github.com/mfikes/planck/wiki/Building) and run

```
$ chmod +x planck
```sh
$ script/build
```

You can download Planck binaries (including older releases) at [http://planck-repl.org/download.html](download.html).
This results in a binary being placed in `planck-c/build`.

### Bug Reporting

Expand Down

0 comments on commit 683bc29

Please sign in to comment.