From 36b4508afcabfc1ece4819e5ec858dadc2a27e5a Mon Sep 17 00:00:00 2001 From: Francisco Ryan Tolmasky I Date: Thu, 4 Sep 2008 05:32:06 -0700 Subject: [PATCH] Revised REAME for starter package. Reviewed by me. --- Tools/READMEs/STARTER-README | 60 +++++------------------------------- 1 file changed, 7 insertions(+), 53 deletions(-) diff --git a/Tools/READMEs/STARTER-README b/Tools/READMEs/STARTER-README index db704d383..551b8c326 100644 --- a/Tools/READMEs/STARTER-README +++ b/Tools/READMEs/STARTER-README @@ -1,58 +1,12 @@ +Welcome to the Cappuccino Starter Package! -*********************************************************************** -* Working with Text Editors -*********************************************************************** +Included you should find the following: -This package includes syntax highlighting modes for both SubEthaEdit and TextMate. +1. Frameworks +2. NewApplication +3. README -*********************************************************************** -* Installing the Development Tools -*********************************************************************** +NewApplication is a stand alone Cappuccino application that you can use as a template to start building your own apps. To get started, just open up NewApplication/index.html in your favorite web browser. A great place to go from there is to read the "Downloading and Getting Started" tutorial found at http://cappuccino.org/learn/tutorials/starter-tutorial.php. This will walk you through these initial steps as well as getting you to do a little coding. -1. Navigate to Tools (the directory containing this README). -2. type sudo ./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: +You can build your entire application right from this sample project, but if you want to dig a little deeper, you can also download the Tools package found at http://cappuccino.org/download/. This will set you up with some great additions like syntax modules for certain text editors and build tools to get extra performance. - 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: ) - -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. - -********************************************************************** -* 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.