diff --git a/README.md b/README.md index 24b7570c1..bd0092a26 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -[![Build Status](https://travis-ci.org/cappuccino/cappuccino.svg?branch=master)](https://travis-ci.org/cappuccino/cappuccino) [![Join the chat at https://gitter.im/cappuccino/cappuccino](https://badges.gitter.im/cappuccino/cappuccino.svg)](https://gitter.im/cappuccino/cappuccino?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Build Status](https://travis-ci.org/cappuccino/cappuccino.svg?branch=master)]( + https://travis-ci.org/cappuccino/cappuccino) +[![Join the chat at https://gitter.im/cappuccino/cappuccino](https://badges.gitter.im/cappuccino/cappuccino.svg)]( + https://gitter.im/cappuccino/cappuccino?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) Welcome to Cappuccino! ====================== @@ -8,7 +11,8 @@ Introduction Cappuccino is an open source framework that makes it easy to build desktop-caliber applications that run in a web browser. -With Cappuccino, you don't concern yourself with HTML, CSS, or the DOM. You write applications with the APIs from Apple's Cocoa frameworks and the Objective-J language. +With Cappuccino, you don't concern yourself with HTML, CSS, or the DOM. You write applications with the APIs from +Apple's Cocoa frameworks and the Objective-J language. Check out a [live demo of the widgets in Cappuccino](https://cappuccino-testbook.5apps.com/#ThemeKitchenSink) @@ -37,11 +41,13 @@ However, you can also work on other platforms using only a simple text editor. Node.js version alpha ------------------ -There is currently an ongoing effort to switch JavaScript platform from [Narwhal](https://narwhaljs.org/) to Node.js. To try the Node.js version, do the following: +There is currently an ongoing effort to switch JavaScript platform from [Narwhal](https://narwhaljs.org/) to Node.js. +To try the Node.js version, do the following: 1. Install Node.js and npm from the [Node.js website](https://nodejs.org/en/). -2. Run `npm set prefix ~/.npm`. This will set the default install location for npm to `~/.npm`. The reasoning behind this is outlined in the section about permission issues below. +2. Run `npm set prefix ~/.npm`. This will set the default install location for npm to `~/.npm`. The reasoning behind +this is outlined in the section about permission issues below. 3. Add this line to your `.zshrc` or equivalent. ```bash @@ -50,13 +56,16 @@ There is currently an ongoing effort to switch JavaScript platform from [Narwhal 4. Restart your shell. -4. Run `npm install -g @objj/cappuccino`. +5. Run `npm install -g @objj/cappuccino`. -5. Done! See below for basic usage. +6. Done! See below for basic usage. ### Permisson issues -By default npm uses `/usr/local/lib/node_modules` as the install location for globally installed packages. This causes problems since users typically lack write permissions there. It is therefore recommended to either use a version manager, or change npm's default install location manually (which is what we did above). For more details on how to do this, see [this article](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally). +By default npm uses `/usr/local/lib/node_modules` as the install location for globally installed packages. This causes +problems since users typically lack write permissions there. It is therefore recommended to either use a version +manager, or change npm's default install location manually (which is what we did above). For more details on how to do +this, see [this article](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally). ### Basic usage @@ -69,23 +78,28 @@ If the install succeeded you will be able to do the following to create a simple ### Building Cappuccino from source -If you want to build Cappuccino from source you should clone the GitHub repository at https://github.com/cappuccino/cappuccino/ and checkout the `node-jake` branch. Then you can use the command `jake install` to install Cappuccino and its tools locally. +If you want to build Cappuccino from source you should clone the GitHub repository at +https://github.com/cappuccino/cappuccino/ and checkout the `node-jake` branch. Then you can use the command +`jake install` to install Cappuccino and its tools locally. To summarize: 1. `git clone https://github.com/cappuccino/cappuccino.git` 2. `cd cappuccino` -3. `git checkout node-jake` +3. `git checkout node` 4. Make changes to the codebase. -5. `jake install` +5. Make sure the environment variable `$CAPP_BUILD` is set to the desired build path. +6. Run `jake install` to build and install Cappuccino. -Beware that building and installing Cappuccino from source will overwrite the binaries installed from npm. To go back, simply run `npm install -g @objj/cappuccino` again. +Beware that building and installing Cappuccino from source will overwrite the binaries installed from npm. To undo this, + simply run `npm install -g @objj/cappuccino` again. Getting Started --------------- To write you first application, [download the starter package](http://www.cappuccino-project.org/#download). -To contribute to Cappuccino, please read here: [Getting and Building the Source](https://github.com/cappuccino/cappuccino/wiki/Getting-and-building-the-source). +To contribute to Cappuccino, please read here: [Getting and Building the Source]( + https://github.com/cappuccino/cappuccino/wiki/Getting-and-building-the-source). License -------