280north / cappuccino

Web Application Framework in JavaScript and Objective-J

This URL has Read+Write access

cappuccino / README
raw normal view history
a1920c55 » tolmasky 2008-09-05 Fix for http://cappuccino.l... 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
16 For more information, see http://cappuccino.org.
17
18 System Requirements
19 -------------------
20 To run Cappuccino applications, all you need is a web browser that understands
21 JavaScript.
22
2ba2bb81 » suitmymind 2009-05-20 readme file updated (issue ... 23 To build Cappuccino itself, please read more here :
a1920c55 » tolmasky 2008-09-05 Fix for http://cappuccino.l... 24
2ba2bb81 » suitmymind 2009-05-20 readme file updated (issue ... 25 - http://wiki.github.com/280north/cappuccino/getting-and-building-the-source
a1920c55 » tolmasky 2008-09-05 Fix for http://cappuccino.l... 26
27 If you're using Windows, you'll also need Cygwin: http://www.cygwin.com/
28
29 Finally, if you want to easily stay up to date with the latest developments
30 and contribute your work back to the Cappuccino community, you'll want to
31 install Git: http://git-scm.com/
32
33 Getting Started
34 ---------------
35 These instructions are for building a development copy of Cappuccino. If you'd
36 just like to get started using Cappuccino for your web apps, you should
37 instead download a pre-compiled copy of Cappuccino from:
38
39 http://cappuccino.org/download/
40
a1b680b7 » tolmasky 2009-03-21 Updated README to reflect n... 41 To build Cappuccino from source, simply type "rake" from within the root of the Cappuccino directory.
42 This will build a "release" copy of the frameworks. Typing "rake debug" will build a debug version.
43 "rake install" will build Cappuccino and associated tools and install them for general use (similar to
44 downloading the tools from the website).
a1920c55 » tolmasky 2008-09-05 Fix for http://cappuccino.l... 45
46 Getting Help
47 ------------
48 If you need help with Cappuccino, you can get help from the following sources:
49
50 - FAQ: http://cappuccino.org/discuss/faq.php
51 - Documentation: http://cappuccino.org/learn/
52 - Wiki: http://github.com/280north/cappuccino/wikis
a1b680b7 » tolmasky 2009-03-21 Updated README to reflect n... 53 - Mailing Lists: http://groups.google.com/group/objectivej
2ba2bb81 » suitmymind 2009-05-20 readme file updated (issue ... 54 http://groups.google.com/group/objectivej-dev
a1920c55 » tolmasky 2008-09-05 Fix for http://cappuccino.l... 55 - IRC: irc://irc.freenode.net#cappuccino
56
57 If you discover any bugs, please file a ticket at:
58
2ba2bb81 » suitmymind 2009-05-20 readme file updated (issue ... 59 http://github.com/280north/cappuccino/issues.
a1920c55 » tolmasky 2008-09-05 Fix for http://cappuccino.l... 60
61 License
62 -------
63 This library is free software; you can redistribute it and/or modify it under
64 the terms of the GNU Lesser General Public License as published by the Free
65 Software Foundation; either version 2.1 of the License, or (at your option)
66 any later version.
67
68 This library is distributed in the hope that it will be useful, but WITHOUT
69 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
70 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
71 details.
72
73 You should have received a copy of the GNU Lesser General Public License along
74 with this library; if not, write to the Free Software Foundation, Inc., 51
75 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA