forked from sproutcore/abbot
/
README.txt
102 lines (71 loc) · 3.62 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
sproutcore - abbot
by Charles Jolley and contributors
http://www.sproutcore.com
http://github.com/sproutit/sproutcore-abbot
== DESCRIPTION:
SproutCore is a platform for building native look-and-feel applications on
the web. This Ruby library includes a copy of the SproutCore JavaScript
framework as well as a Ruby-based build system called Abbot.
Abbot is a build system for creating static web content. You can supply Abbot with a collection of JavaScript, HTML, CSS and image files and it will
combine the files into a bundle that are optimized for efficient, cached
deliver directly from your server or using a CDN.
Some of the benefits of using Abbot versus assembling your own content
include:
* Easy maintenance. Organize your source content in a way that is useful for
you without impacting performance on loaded apps.
* Automatically versioned URLs. Serve content with long expiration dates
while Abbot handles the cache invalidation for you.
* Dependency management. Divide your code into frameworks; load 3rd party
libraries. Abbot will make sure everything loads in the correct order.
* Packing. Combines JavaScript and CSS into single files to minimize the
number of resources you download for each page.
Although Abbot is intended primarily for building Web applications that
use the SproutCore JavaScript framework, you can also use it to efficiently build any kind of static web content, even if SproutCore is not involved.
Abbot can be used both directly from the command line or as a ruby library.
== USING ABBOT WITH SPROUTCORE:
This gem includes both the Abbot build tools and a copy of the SproutCore
JavaScript framework. You can use built-in commands to create, develop,
build, and deploy SproutCore-based applications.
== KNOWN LIMITATIONS:
* Currently does not support sites using relative-links. You must specify
the absolute path you expect built targets to be hosted as.
== SYNOPSIS:
To create a new project:
sc-init my_app
To test said project:
cd my_app
sc-server
open http://localhost:4020/my_app (in web browser)
Write code, refresh, debug. Once you are ready to deploy, build your static
output using:
cd my_app
sc-build my_app -rc
Copy the resulting files found in my_app/tmp/build to your server and you are
deployed!
== REQUIREMENTS:
* Ruby 1.8.6 or later. Ruby 1.9 is currently untested
* extlib 0.9.9 or later
* rack 0.9.1 or later
* erubis 2.6.2 or later
* json_pure 1.1.0 or later
== INSTALL:
sudo gem install sproutcore
== LICENSE:
Copyright (c) 2009 Apple Inc.
Portions copyright (c) 2006-2009 Sprout Systems, Inc. and contributors
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.