Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 95 lines (68 sloc) 3.801 kb
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
1 Welcome to Cappuccino!
2 ======================
3
4 Introduction
5 ------------
6 Cappuccino is an open source framework that makes it easy to build
7 desktop-caliber applications that run in a web browser.
8
9 Cappuccino is built on top of standard web technologies like JavaScript, and
10 it implements most of the familiar APIs from GNUstep and Apple's Cocoa
11 frameworks. When you program in Cappuccino, you don't need to concern yourself
12 with the complexities of traditional web technologies like HTML, CSS, or even
13 the DOM. The unpleasantries of building complex cross browser applications are
14 abstracted away for you.
15
3709604 @aljungberg Better formatting, clickable links and basic code styling for the Dox…
aljungberg authored
16 For more information, see <http://cappuccino.org>.
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
17
18 System Requirements
19 -------------------
20 To run Cappuccino applications, all you need is a web browser that understands
21 JavaScript.
22
80cac38 @aljungberg 0.9.2 installation instructions.
aljungberg authored
23 To build Cappuccino itself, please read below. More information is available
24 here: [Getting and Building the Source](http://wiki.github.com/cappuccino/cappuccino/getting-and-building-the-source>).
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
25
3709604 @aljungberg Better formatting, clickable links and basic code styling for the Dox…
aljungberg authored
26 If you're using Windows, you'll also need [Cygwin](http://www.cygwin.com/).
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
27
28 Finally, if you want to easily stay up to date with the latest developments
29 and contribute your work back to the Cappuccino community, you'll want to
3709604 @aljungberg Better formatting, clickable links and basic code styling for the Dox…
aljungberg authored
30 [install Git](http://git-scm.com/).
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
31
32 Getting Started
33 ---------------
80cac38 @aljungberg 0.9.2 installation instructions.
aljungberg authored
34 To get started, download and install the current release version of Cappuccino:
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
35
6217fc8 @aljungberg Given the large number of changes, this will be Cappuccino 0.9.5 ins…
aljungberg authored
36 $ curl https://raw.github.com/cappuccino/cappuccino/v0.9.5/bootstrap.sh >/tmp/cappuccino_bootstrap.sh && sh /tmp/cappuccino_bootstrap.sh
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
37
80cac38 @aljungberg 0.9.2 installation instructions.
aljungberg authored
38 If you'd just like to get started using Cappuccino for your web apps, you are done.
39
40 The rest of these instructions are for building a development copy of Cappuccino.
3709604 @aljungberg Better formatting, clickable links and basic code styling for the Dox…
aljungberg authored
41 To build Cappuccino from source, check out the most recent stable version from GitHub:
7871116 Update the README to more accurately reflect the process.
Ross Boucher authored
42
2f7b295 @Ch00rD replaced "280north" by "cappuccino" for github install script and doc…
Ch00rD authored
43 $ git clone git://github.com/cappuccino/cappuccino.git (git)
7871116 Update the README to more accurately reflect the process.
Ross Boucher authored
44
45 or download the zipball of the most recent source code:
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
46
2f7b295 @Ch00rD replaced "280north" by "cappuccino" for github install script and doc…
Ch00rD authored
47 <http://github.com/cappuccino/cappuccino/zipball/master> (zip)
fe91331 @tolmasky Updated readme file to remove references to rake.
tolmasky authored
48
80cac38 @aljungberg 0.9.2 installation instructions.
aljungberg authored
49 Then, simply type `jake` from within the root of the Cappuccino directory. If you
50 get an error like `jake: command not found`, you forgot to run the bootstrap script
51 as described above.
7871116 Update the README to more accurately reflect the process.
Ross Boucher authored
52
80cac38 @aljungberg 0.9.2 installation instructions.
aljungberg authored
53 Jake will build a "release" copy of the frameworks. Typing `jake debug` will
3709604 @aljungberg Better formatting, clickable links and basic code styling for the Dox…
aljungberg authored
54 build a debug version.
55
56 `jake install` will build Cappuccino and associated tools and install them for general use.
fe91331 @tolmasky Updated readme file to remove references to rake.
tolmasky authored
57
2571b24 @tolmasky Removed TextMate and Xcode files since the ones being used now have t…
tolmasky authored
58 Editors
3709604 @aljungberg Better formatting, clickable links and basic code styling for the Dox…
aljungberg authored
59 -------
60 The Cappuccino TextMate Bundle: <http://github.com/malkomalko/Cappuccino.tmbundle>.
61
62 The Cappuccino Xcode Plugin: <http://github.com/rbartolome/xcode-cappuccino>.
2571b24 @tolmasky Removed TextMate and Xcode files since the ones being used now have t…
tolmasky authored
63
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
64 Getting Help
65 ------------
66 If you need help with Cappuccino, you can get help from the following sources:
67
3709604 @aljungberg Better formatting, clickable links and basic code styling for the Dox…
aljungberg authored
68 - [FAQ](http://cappuccino.org/discuss/faq.php)
69 - [Documentation](http://cappuccino.org/learn/)
2f7b295 @Ch00rD replaced "280north" by "cappuccino" for github install script and doc…
Ch00rD authored
70 - [Wiki](http://github.com/cappuccino/cappuccino/wikis)
3709604 @aljungberg Better formatting, clickable links and basic code styling for the Dox…
aljungberg authored
71 - Mailing Lists:
72 - [Objective-J](http://groups.google.com/group/objectivej)
73 - [Objective-J Developers](http://groups.google.com/group/objectivej-dev)
74 - IRC: irc://irc.freenode.net#cappuccino
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
75
76 If you discover any bugs, please file a ticket at:
77
2f7b295 @Ch00rD replaced "280north" by "cappuccino" for github install script and doc…
Ch00rD authored
78 <http://github.com/cappuccino/cappuccino/issues>
a1920c5 @tolmasky Fix for http://cappuccino.lighthouseapp.com/projects/16499/tickets/2-…
tolmasky authored
79
80 License
81 -------
82 This library is free software; you can redistribute it and/or modify it under
83 the terms of the GNU Lesser General Public License as published by the Free
84 Software Foundation; either version 2.1 of the License, or (at your option)
85 any later version.
86
87 This library is distributed in the hope that it will be useful, but WITHOUT
88 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
89 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
90 details.
91
92 You should have received a copy of the GNU Lesser General Public License along
93 with this library; if not, write to the Free Software Foundation, Inc., 51
94 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Something went wrong with that request. Please try again.