Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
26 changed files
with
669 additions
and
419 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
|
||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Download Ringo | ||
|
||
Head to the [github download page](https://github.com/ringo/ringojs/downloads) | ||
for a full list of Ringo releases. | ||
|
||
## Binary Releases | ||
|
||
* [RingoJS v0.8 tar.gz archive](http://github.com/downloads/ringo/ringojs/ringojs-0.8.tar.gz) | ||
* [RingoJS v0.8 zip archive](http://github.com/downloads/ringo/ringojs/ringojs-0.8.zip) | ||
* [RingoJS v0.8 Debian package](http://github.com/downloads/ringo/ringojs/ringojs_0.8-1_all.deb) | ||
* [RingoJS v0.8 Debian daemon package](http://github.com/downloads/ringo/ringojs/ringojs-daemon_0.8-1_all.deb) | ||
|
||
## Source Releases | ||
|
||
* [RingoJS v0.8 tar.gz source archive](http://github.com/ringo/ringojs/tarball/v0.8.0) | ||
* [RingoJS v0.8 zip source archive](http://github.com/ringo/ringojs/zipball/v0.8.0) | ||
|
||
## Git Snapshots | ||
|
||
* [RingoJS master tar.gz git snapshot](http://github.com/ringo/ringojs/tarball/master) | ||
* [RingoJS master zip git snapshot](http://github.com/ringo/ringojs/zipball/master) | ||
|
||
## Packages for Ringo | ||
|
||
You can use the Ringo package repository `rpr` to install packages, which is located at [packages.ringojs.org](http://packages.ringojs.org) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Get Involved | ||
|
||
|
||
[RingoJS is on Twitter](http://twitter.com/ringojs). Follow us to keep up with latest development! | ||
|
||
### IRC Channel | ||
|
||
Some contributors can usually be found on the [#ringojs IRC channel](irc://irc.freenode.net/ringojs) at irc.freenode.net. An [IRC log](/bot/) is also available. | ||
|
||
### Mailing List | ||
|
||
We have a [mailing list](http://groups.google.com/group/ringojs) hosted on Google Groups. You're welcome to ask questions there, or just say hello and tell us how you're using Ringo. | ||
|
||
### Weblog | ||
|
||
Main Ringo developer Hannes Wallnöfer has recently started a [Ringo related weblog](http://hns.github.com/). | ||
|
||
## Submit Packages | ||
|
||
You can upload your packages an [packages.ringojs.org](http://packages.ringojs.org), the Ringo package registry. If you already know `npm` from Node.js, it will be easy to use the `rpr` command-line tool to publish your Ringo modules and share them with other users. Please use semantic versioning for your packages to make dependency tracking easier. | ||
|
||
## Contributing Code | ||
|
||
To contribute a patch please fork the GitHub [ringojs repository] and push | ||
your changes to your own tree. When you think your code is ready and stable | ||
create a pull request in the main repository to have your changes merged. | ||
|
||
<iframe src="http://ghbtns.com/github-btn.html?user=ringo&repo=ringojs&type=fork&count=true&size=large" | ||
allowtransparency="true" frameborder="0" scrolling="0" width="95px" height="30px"></iframe> | ||
|
||
Please make sure to only propose one feature or bug fix per pull request. | ||
Mixing a lot of stuff into one pull request needlessly complicates and delays | ||
handling. | ||
|
||
Before pouring serious work into some new feature it may be a good idea | ||
to let us know via the mailing list or on IRC. This way you avoid duplicating work or pouring | ||
effort into something that has little chance to be accepted in the main tree. | ||
|
||
[ringojs repository]: http://github.com/ringo/ringojs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Get Started | ||
|
||
This is a short guide on how to install RingoJS. See [Documentation](documentation) for an overview of documentation resources. | ||
|
||
## Ringo requires Java SE | ||
|
||
We recommend the Java SE 6 or higher to run Ringo, which you find at [the Oracle download page](http://www.oracle.com/technetwork/java/javase/downloads/jdk6-jsp-136632.html) or on Debian simply `apt-get install openjdk-6-jre`. However, the minimal required version is Java SE 5. | ||
|
||
## Download the latest release | ||
|
||
Download the latest Ringo release from the [download page](download). On Debian systems you can install the `.deb` or unpack the archive you downloaded. After that don't forget to add the `/bin` directory to the `PATH` environment variable. Ringo is now ready to use. | ||
|
||
## Starting the Ringo shell | ||
|
||
Run the ringo script in the bin directory without arguments: | ||
|
||
$ ./bin/ringo | ||
|
||
This should start a shell session with a `>>` prompt. Use the `include`, `require`, or `import` functions to load any [RingoJS modules](http://ringojs.org/api/). | ||
|
||
>> var fs = require('fs'); | ||
>> var file = fs.open('README.md'); | ||
>> var lines = [line for (line in file)]; | ||
|
||
Tips: | ||
|
||
* Hitting `Tab` will try to auto-complete your current input. | ||
* You can scroll through your session history using the Up and Down keys | ||
* Ringo supports most of JavaScript 1.8 and ECMAScript 5. | ||
|
||
## Running the demo webapp | ||
|
||
Simply pass the main file of the app to the ringo command: | ||
|
||
$ ./bin/ringo apps/demo/main.js | ||
|
||
This will start the RingoJS demo app on port 8080. Access the app in your browser by going to <http://localhost:8080/> | ||
|
||
Tips: | ||
|
||
* You can also run an application and the shell at the same time by adding the `-i` or `--interactive` option before the application name | ||
* Use Ringo's `-h` or `--help` options for more information on available options. | ||
* Start the debugger with `-d` to get a better insight into your application. | ||
|
||
## Starting your own application | ||
|
||
To start hacking on your own RingoJS application, use the ringo-admin create script to create a new app: | ||
|
||
$ ./bin/ringo-admin create [app directory] | ||
|
||
If you don't pass the app directory on the command line the script will prompt you for it. Once the application has been created you can start it by running its main.js script: | ||
|
||
$ ./bin/ringo [app directory]/main.js | ||
|
||
If you don't find what you are looking for please tell us on the [mailing list][group] or in the [IRC channel][irc]! | ||
|
||
[group]: http://groups.google.com/group/ringojs | ||
[irc]: irc://freenode.org/ringojs |
Oops, something went wrong.