Make the README file use Markdown instead of rdoc syntax. Change its extension accordingly.
This commit is contained in:
parent
7735f545c7
commit
302e51e7fd
63
README.markdown
Normal file
63
README.markdown
Normal file
@ -0,0 +1,63 @@
|
||||
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.4 and higher
|
||||
* Opera 9.25 and higher
|
||||
* Chrome 1.0 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
|
||||
`dist/prototype.js` 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 ###
|
||||
|
||||
`prototype.js` is a composite file generated from many source files in
|
||||
the `src/` directory. To build Prototype, you'll need:
|
||||
|
||||
* a copy of the Prototype source tree, either from a distribution tarball or
|
||||
from the Git 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,
|
||||
|
||||
* `rake dist` will preprocess the Prototype source using Sprockets and
|
||||
generate the composite `dist/prototype.js`.
|
||||
* `rake package` will create a distribution tarball in the
|
||||
`pkg/` directory.
|
||||
|
||||
Contributing to Prototype
|
||||
-------------------------
|
||||
|
||||
Check out the Prototype source with
|
||||
|
||||
$ git clone git://github.com/sstephenson/prototype.git
|
||||
$ cd prototype
|
||||
$ git submodule init
|
||||
$ git submodule update vendor/sprockets vendor/pdoc vendor/unittest_js
|
||||
|
||||
Find out how to contribute: <http://prototypejs.org/contribute>.
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
Please see the online Prototype API: <http://prototypejs.org/api>.
|
60
README.rdoc
60
README.rdoc
@ -1,60 +0,0 @@
|
||||
= 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.4 and higher
|
||||
* Opera 9.25 and higher
|
||||
* Chrome 1.0 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 Git 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
|
||||
$ git clone git://github.com/sstephenson/prototype.git
|
||||
$ cd prototype
|
||||
$ git submodule init
|
||||
$ git submodule update
|
||||
|
||||
Find out how to contribute:
|
||||
http://prototypejs.org/contribute
|
||||
|
||||
== Documentation
|
||||
|
||||
Please see the online Prototype API:
|
||||
http://prototypejs.org/api
|
||||
|
Loading…
Reference in New Issue
Block a user