fuwafuwa
/
etherpad-lite
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improved the README a lot

This commit is contained in:
Peter 'Pita' Martischka 2011-06-02 12:29:09 +01:00
parent 280b4ab9c7
commit d10c957077
1 changed files with 26 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -5,7 +5,7 @@ is based on node.js what makes it much leigther and more stable than the origina
is that this will encourage more users to install a realtime collaborative editor. A smaller and well is that this will encourage more users to install a realtime collaborative editor. A smaller and well
documented codebase makes it easier for developers to improve the code documented codebase makes it easier for developers to improve the code
# Online demo **Online demo**<br>
Visit <http://pitapoison.de:9001> to test it live Visit <http://pitapoison.de:9001> to test it live
# Why use Etherpad Lite? # Why use Etherpad Lite?
@ -16,21 +16,33 @@ Visit <http://pitapoison.de:9001> to test it live
* Well documented * Well documented
# Installation # Installation
1. download latest node.js version from <http://nodejs.org/> and build it with this instructions <https://github.com/joyent/node/wiki/Installation>. <br>THE NODE.JS VERSION OF YOUR LINUX REPOSITORY MAY BE TOO OLD. PLEASE COMPILE FROM THE SOURCE TO GET SURE YOU HAVE THE LATEST VERSION. 1. Download latest node.js version from <http://nodejs.org/> and build it with this instructions <https://github.com/joyent/node/wiki/Installation>. <br>THE NODE.JS VERSION OF YOUR LINUX REPOSITORY MAY BE TOO OLD. PLEASE COMPILE FROM THE SOURCE TO GET SURE YOU HAVE THE LATEST VERSION.
2. install npm `curl http://npmjs.org/install.sh | sh` 2. Install npm `curl http://npmjs.org/install.sh | sh`
3. ensure you have installed the sqlite develob libraries && gzip `apt-get install libsqlite3-dev gzip` 3. Ensure you have installed the sqlite develob libraries, gzip and git `apt-get install libsqlite3-dev gzip git-core`
4. install etherpad-lite `npm install -g ep-lite` 4. Clone the git repository `git clone 'git://github.com/Pita/etherpad-lite.git'`
5. start with `ep-lite` 5. Install the dependencies `cd etherpad-lite && npm link`
6. Open your web browser and visit <http://localhost:9001> 6. Start it with `bin/run.sh`
7. Open your web browser and visit <http://localhost:9001>
# Contribute # Next Steps
Look at the TODO list at <https://github.com/Pita/etherpad-lite/wiki/TODO>. You can modify the settings in the file settings.json
You can join the mailinglist <http://groups.google.com/group/etherpad-lite-dev> or go to the freenode irc channel #etherpad-lite-dev
# Debug You can update to the latest version with `git pull origin && npm link`
1. cd bin/runDebug.sh
2. Open Safari or Chrome and visit http://IPSERVER:8080 You can debug with `bin/runDebug.sh`
# Develop
If you're new to git and github, start here <http://learn.github.com/p/intro.html>.
If you're new to node.js, start with this video <http://youtu.be/jo_B4LTHi3I>.
If you wanna find out how Etherpads Easysync works (the library that makes it realy realtime), start with this [PDF](https://github.com/Pita/etherpad-lite/raw/master/doc/easysync/easysync-full-description.pdf) (complex, but worth reading it).
You know all this and just want to know how you can help? Look at the [TODO list](https://github.com/Pita/etherpad-lite/wiki/TODO).
You can join the [mailinglist](http://groups.google.com/group/etherpad-lite-dev) or go to the freenode irc channel [#etherpad-lite-dev](http://webchat.freenode.net?channels=#etherpad-lite-dev)
You also help the project, if you only host a ep-lite instance and share your experience with us.
# License # License
Apache License v2 <http://www.apache.org/licenses/LICENSE-2.0.html> [Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html)