Permalink
Browse files

Better formatting for README file.

  • Loading branch information...
1 parent ffa4f3f commit d3c07bf83d57f911787703d4e0ab7692eb33bac1 @fdb fdb committed May 8, 2012
Showing with 40 additions and 32 deletions.
  1. +40 −32 README.md
View
@@ -2,51 +2,59 @@ NodeBox 3
=========
NodeBox is a new software application for creating generative art using procedural graphics and a new way to approach graphic design.
-NodeBox is:
+Highlights:
+
- Node based -- the software uses a non-destructive workflow where every operation is represented by a visual block of code.
-- Open Source -- NodeBox is completely free to use and extend under the GPL license.
-- Python -- Nodes are written in the popular dynamic programming language.
+- Open to extend -- look and change the source of every code block.
+- Python or Clojure -- Nodes can be written in popular dynamic programming languages.
For downloads, documentation and the forum, visit the website:
-http://alpha.nodebox.net/
+<http://alpha.nodebox.net/>
+
+## Building on Mac
-To get started on Mac:
+If you're on Mac OS X Lion or higher, Git is already installed. For older versions, install Git first (<http://git-scm.com/>).
-- Install Git (http://git-scm.com/)
-- From the Terminal, run:
+Then from the Terminal, run:
- git clone git://github.com/nodebox/nodebox.git
- cd nodebox
- ant run
+ git clone git://github.com/nodebox/nodebox.git
+ cd nodebox
+ ant run
- # To create a full app (the build will be in dist/mac):
- ant dist-mac
+ # To create a full app (the build will be in dist/mac):
+ ant dist-mac
+
+## Building on Windows
-To get started on Windows:
+- Install [Git](<http://git-scm.com/>).
+- Install the [Java SDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
+- Install [Unicode NSIS](http://www.scratchpaper.com/).
+- Install [Ant](http://ant.apache.org/).
-- Install Git (http://git-scm.com/)
-- Install the Java SDK (http://www.oracle.com/technetwork/java/javase/downloads/index.html)
-- Install Unicode NSIS (http://www.scratchpaper.com/)
-- Install Ant (http://ant.apache.org/)
-- From the command prompt, run:
+From the command prompt, run:
- # Setup the correct environment variables
- set PATH=%PATH%;c:\java\apache-ant-1.8.2\bin
- set JAVA_HOME=c:\java\jdk6
+ # Setup the correct environment variables
+ set PATH=%PATH%;c:\java\apache-ant-1.8.2\bin
+ set JAVA_HOME=c:\java\jdk6
- git clone git://github.com/nodebox/nodebox.git
- # Modify build.properties to point to the correct installation paths of the JRE and NSIS.
+ git clone git://github.com/nodebox/nodebox.git
+ # Modify build.properties to point to the correct installation paths of the JRE and NSIS.
- cd nodebox
- ant run
+ cd nodebox
+ ant run
- # To create a full app (the EXE will be in dist):
- ant dist-win
+ # To create a full app (the EXE will be in dist):
+ ant dist-win
+
+## Building on Ubuntu Linux
+
+ sudo apt-get install git-core openjdk-6-jdk ant
+ git clone git://github.com/nodebox/nodebox.git
+ cd nodebox
+ ant run
+
+## Bugs / Features
-To get started on Linux (Ubuntu):
+We use [Pivotal Tracker](https://www.pivotaltracker.com/projects/32126) to track bugs and new features.
- sudo apt-get install git-core openjdk-6-jdk ant
- git clone git://github.com/nodebox/nodebox.git
- cd nodebox
- ant run

0 comments on commit d3c07bf

Please sign in to comment.