Files
cappuccino/Tools/READMEs/TOOLS-README
T

91 lines
3.6 KiB
Plaintext

***********************************************************************
* Working with Text Editors
***********************************************************************
This package includes syntax highlighting modes for both SubEthaEdit, Coda, TextMate, and vim.
+ SubEthaEdit
- Unarchive Tools/Editors/Objective-J.mode.zip
- Double click the generated Objective-J.mode file
+ Coda
- Unarchive Tools/Editors/Objective-J.mode.zip
- Place the generated Objective-J.mode file in ~/Library/Application Support/Coda/Modes
+ TextMate (Thanks to Michael Sheets for providing us with this!)
- Unarchive Tools/Editors/JavaScript Objective-J.tmbundle.zip
- Double click the generated "JavaScript Objective-J.tmbundle" file
+ Vim (Thanks to Shawn MacIntyre for providing us with this!)
- Place Tools/Editors/objj.vim in ~/.vim/syntax/
- in ~/.vimrc, add:
syntax on
au BufNewFile,BufRead *.j setf objj
Put the file in objj.vim in ~/.vim/syntax/
In ~/.vimrc add:
syntax on
au BufNewFile,BufRead *.j setf objj
This will load the obj-j syntax highlighting when you open files ending in .j
***********************************************************************
* Installing the Development Tools
***********************************************************************
1. Navigate to Tools (the directory containing this README).
2. Enter "chmod +x install-tools"
3. Enter "sudo sh ./install-tools"
4. 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:/Users/tolmasky/Development/Cappuccino/Tools/Scripts/:/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: )
5. 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.
6. 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.
**********************************************************************
* objj
**********************************************************************
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).
***********************************************************************
* steam
***********************************************************************
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.