Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 63 lines (44 sloc) 2.004 kb
302e51e @tobie Make the README file use Markdown instead of rdoc syntax. Change its …
tobie authored
1 Prototype
2 =========
3
4 #### An object-oriented JavaScript framework ####
5
6 Prototype is a JavaScript framework that aims to ease development of dynamic
7 web applications. It offers a familiar class-style OO framework, extensive
8 Ajax support, higher-order programming constructs, and easy DOM manipulation.
9
10 ### Targeted platforms ###
11
12 Prototype currently targets the following platforms:
13
14 * Microsoft Internet Explorer for Windows, version 6.0 and higher
15 * Mozilla Firefox 1.5 and higher
16 * Apple Safari 2.0.4 and higher
17 * Opera 9.25 and higher
18 * Chrome 1.0 and higher
19
20 Using Prototype
21 ---------------
22
23 To use Prototype in your application, download the latest release from the
24 Prototype web site (<http://prototypejs.org/download>) and copy
25 `dist/prototype.js` to a suitable location. Then include it in your HTML
26 like so:
27
28 <script type="text/javascript" src="/path/to/prototype.js"></script>
29
30 ### Building Prototype from source ###
31
32 `prototype.js` is a composite file generated from many source files in
33 the `src/` directory. To build Prototype, you'll need:
34
35 * a copy of the Prototype source tree, either from a distribution tarball or
36 from the Git repository (see below)
37 * Ruby 1.8.2 or higher (<http://www.ruby-lang.org/>)
24141e9 @tobie Typographic nitpicking.
tobie authored
38 * Rake--Ruby Make (<http://rake.rubyforge.org/>)
302e51e @tobie Make the README file use Markdown instead of rdoc syntax. Change its …
tobie authored
39 * RDoc, if your Ruby distribution does not include it
40
41 From the root Prototype directory,
42
43 * `rake dist` will preprocess the Prototype source using Sprockets and
44 generate the composite `dist/prototype.js`.
45 * `rake package` will create a distribution tarball in the
46 `pkg/` directory.
47
48 Contributing to Prototype
49 -------------------------
50
51 Check out the Prototype source with
52
53 $ git clone git://github.com/sstephenson/prototype.git
54 $ cd prototype
55 $ git submodule init
56 $ git submodule update vendor/sprockets vendor/pdoc vendor/unittest_js
57
58 Find out how to contribute: <http://prototypejs.org/contribute>.
59
60 Documentation
61 -------------
62
d98e5c1 @tobie Amend README file.
tobie authored
63 Please see the online Prototype API: <http://api.prototypejs.org>.
Something went wrong with that request. Please try again.