Skip to content

Commit

Permalink
Fixed typos Tools README and updated to reflect new tools.
Browse files Browse the repository at this point in the history
[cappuccino#240 state:resolved]

Reviewed by me.
  • Loading branch information
Francisco Tolmasky committed Mar 21, 2009
1 parent ffe1f9c commit 436c466
Showing 1 changed file with 7 additions and 33 deletions.
40 changes: 7 additions & 33 deletions Tools/READMEs/TOOLS-README
Expand Up @@ -18,6 +18,7 @@ This package includes syntax highlighting modes for both SubEthaEdit, Coda, Text

+ TextMate (Thanks to Michael Sheets for providing us with this!)

- NOTE: TextMate now has built-in support for Objective-J, but the copy included here is probably more up to date.
- Unarchive Tools/Editors/JavaScript Objective-J.tmbundle.zip
- Double click the generated "JavaScript Objective-J.tmbundle" file

Expand All @@ -43,33 +44,8 @@ This will load the obj-j syntax highlighting when you open files ending in .j

1. Navigate to Tools (the directory containing this README).
2. Enter "sudo sh install-tools"
3. Once installation is complete, you will be presented with a list of
options that looks something like this:

Installation of the Objective-J tools to /usr/local is almost complete!

Several environment variables must be set:

- PATH should include /usr/local/bin:

export PATH=$PATH:/usr/local/bin

(currently: /bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/bin:/usr/local/bin:/opt/local/bin:/opt/bin:/Users/tolmasky/bin)

- OBJJ_HOME should be set to /usr/local/share/objj:

export OBJJ_HOME=/usr/local/share/objj

(currently: )

- STEAM_BUILD should be set to the build directory of your choice (e.x. /Users/tolmasky/objj_build):

export STEAM_BUILD=/Users/tolmasky/objj_build

(currently: )

4. Chances are you can ignore the first two options. If you chose to install everything to the default location, it should work fine without further modification.
5. Steam (see below) allows you to specify a global Build directory. If you wish to use it, you must set the STEAM_BUILD environment variable. Building Cappuccino from source requires this, for example.
3. You should see this: "Cappuccino Tools Installed"
5. You can optionally specify a global Build directory. If you wish to use it, you must set the STEAM_BUILD environment variable. Building Cappuccino from source requires this, for example.

**********************************************************************
* objj
Expand All @@ -81,14 +57,12 @@ objj is a command line Objective-J interpreter and interactive console.
* objjc
**********************************************************************

objjc is a static preinterpreter for Objectie-J. It will take Objective-J files and essentially convert them to JavaScript. However, for complex interaction between files, you will probably want to use steam (see below).
objjc is a static pre-interpreter for Objective-J. It will take Objective-J files and essentially convert them to JavaScript. However, for complex interaction between files, you will probably want to use steam (see below).

***********************************************************************
* steam
* capp
***********************************************************************

Steam is a simple tool for managing Objective-J projects. Among other things, it allows you to statically pre-interpret entire Objective-J applications so that you can deliver it without requiring client-side pre-interpretation.
capp is a simple tool for creating Objective-J applications.

steam create [-l] path - This will create a new Cappuccino application at the specified path. The resulting project contains a basic Cappuccino application as well as Objective-J and the preprocessed Cappuccino frameworks.

steam build [options] - This builds an application or framework.
steam /path/to/your/app [options]

0 comments on commit 436c466

Please sign in to comment.