Prototype JavaScript framework
Go to file
Tobie Langel bf967e3a41 yet more unittest clean-up 2008-09-02 18:22:57 -07:00
dist Added 'prototype.js' to dist/.gitignore so it won't get added on checkins. 2008-03-27 15:00:35 -05:00
ext/update_helper prototype: Remove usage of the statement from unit tests. 2008-03-16 18:53:51 +00:00
lib prototype: Reorganize the source tree. 2007-01-18 22:24:27 +00:00
src Fixed a faulty variable assignment, the result of my own idiocy last week. 2008-04-04 12:55:59 -05:00
test yet more unittest clean-up 2008-09-02 18:22:57 -07:00
CHANGELOG Fix issue where Safari improperly reports an element as a descendant of itself. 2008-03-30 21:02:47 -05:00
LICENSE prototype: Update copyright date in LICENSE 2008-01-25 22:54:47 +00:00
README prototype: Update the list of officially supported browsers in the README. 2008-01-25 22:54:14 +00:00
Rakefile refactored unit tests quite a bit. Added JS and CSS fixtures. 2008-09-02 18:19:41 -07:00

README

= Prototype
==== An object-oriented JavaScript framework

Prototype is a JavaScript framework that aims to ease development of dynamic 
web applications.  It offers a familiar class-style OO framework, extensive
Ajax support, higher-order programming constructs, and easy DOM manipulation.

=== Targeted platforms

Prototype currently targets the following platforms:

* Microsoft Internet Explorer for Windows, version 6.0 and higher
* Mozilla Firefox 1.5 and higher
* Apple Safari 2.0 and higher
* Opera 9.25 and higher

== Using Prototype

To use Prototype in your application, download the latest release from the 
Prototype web site (http://prototypejs.org/download) and copy 
<tt>dist/prototype.js</tt> to a suitable location. Then include it in your HTML
like so:

  <script type="text/javascript" src="/path/to/prototype.js"></script>

=== Building Prototype from source

<tt>prototype.js</tt> is a composite file generated from many source files in 
the <tt>src/</tt> directory. To build Prototype, you'll need:

* a copy of the Prototype source tree, either from a distribution tarball or
  from the Subversion repository (see below)
* Ruby 1.8.2 or higher (http://www.ruby-lang.org/)
* Rake -- Ruby Make (http://rake.rubyforge.org/)
* RDoc, if your Ruby distribution does not include it

From the root Prototype directory,

* <tt>rake dist</tt> will preprocess the Prototype source using ERB and 
  generate the composite <tt>dist/prototype.js</tt>.
* <tt>rake package</tt> will create a distribution tarball in the 
  <tt>pkg/</tt> directory.

== Contributing to Prototype

Check out the Prototype source with 
  $ svn co http://svn.rubyonrails.org/rails/spinoffs/prototype/trunk/ prototype

Find out how to contribute:
  http://prototypejs.org/contribute

== Documentation

Please see the online Prototype API:
  http://prototypejs.org/api