From d10c957077d67ddd8e754a6036191d9604ed987f Mon Sep 17 00:00:00 2001 From: Peter 'Pita' Martischka Date: Thu, 2 Jun 2011 12:29:09 +0100 Subject: [PATCH] Improved the README a lot --- README.md | 40 ++++++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7fc21efb..3f568060 100644 --- a/README.md +++ b/README.md @@ -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 documented codebase makes it easier for developers to improve the code -# Online demo +**Online demo**
Visit to test it live # Why use Etherpad Lite? @@ -16,21 +16,33 @@ Visit to test it live * Well documented # Installation -1. download latest node.js version from and build it with this instructions .
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` -3. ensure you have installed the sqlite develob libraries && gzip `apt-get install libsqlite3-dev gzip` -4. install etherpad-lite `npm install -g ep-lite` -5. start with `ep-lite` -6. Open your web browser and visit +1. Download latest node.js version from and build it with this instructions .
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` +3. Ensure you have installed the sqlite develob libraries, gzip and git `apt-get install libsqlite3-dev gzip git-core` +4. Clone the git repository `git clone 'git://github.com/Pita/etherpad-lite.git'` +5. Install the dependencies `cd etherpad-lite && npm link` +6. Start it with `bin/run.sh` +7. Open your web browser and visit -# Contribute -Look at the TODO list at . -You can join the mailinglist or go to the freenode irc channel #etherpad-lite-dev +# Next Steps +You can modify the settings in the file settings.json -# Debug -1. cd bin/runDebug.sh -2. Open Safari or Chrome and visit http://IPSERVER:8080 +You can update to the latest version with `git pull origin && npm link` + +You can debug with `bin/runDebug.sh` + +# Develop +If you're new to git and github, start here . + +If you're new to node.js, start with this video . + +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 -Apache License v2 +[Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html)