From 91347a352862e233787294ccbc834383f04085fc Mon Sep 17 00:00:00 2001 From: Peter 'Pita' Martischka Date: Mon, 1 Aug 2011 19:24:11 +0100 Subject: [PATCH] Improved the README --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d476c9616..51b316f28 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,8 @@ Visit to test it live. You can find the same instanc # Installation -1. Download latest node.js version from and build it with this instructions .
-The Node.js version of your Linux repository might be too old/new. Please compile from the source to get sure you have the correct version. We support node.js version 0.4.* +1. Download the latest 0.4.x node.js release from and build it with this instructions .
+The Node.js version of your Linux repository might be too old/new. Please compile from the source to get sure you have the correct 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'` @@ -40,11 +40,11 @@ The Node.js version of your Linux repository might be too old/new. Please compil # Next Steps You can modify the settings in the file settings.json -You can update to the latest version with `git pull origin && npm install` +You can update to the latest version with `git pull origin`. The next start with bin/run.sh will update the dependencies -You can debug with `bin/runDebug.sh` +You can debug with `bin/debugRun.sh` -Look at the Wiki: [How to put Etherpad Lite behind a reverse Proxy](https://github.com/Pita/etherpad-lite/wiki/How-to-put-Etherpad-Lite-behind-a-reverse-Proxy), [How to deploy Etherpad Lite as a service](https://github.com/Pita/etherpad-lite/wiki/How-to-deploy-Etherpad-Lite-as-a-service). Feel free to improve these wiki pages +You can find more information in the [wiki](https://github.com/Pita/etherpad-lite/wiki). Feel free to improve these wiki pages # Develop If you're new to git and github, start here . @@ -58,5 +58,13 @@ You can join the [mailinglist](http://groups.google.com/group/etherpad-lite-dev) You also help the project, if you only host a ep-lite instance and share your experience with us. +Look at our [FAQ Page](https://github.com/Pita/etherpad-lite/wiki/FAQ) + +# Modules created for this project + +* [ueberDB](https://github.com/Pita/ueberDB) "transforms every database into a object key value store" - manages all database access +* [doc.md](https://github.com/Pita/doc.md) "A simple JSDoc documenation tool that creates markdown for node.js modules exports" - is used to generate the docs +* [channels](https://github.com/Pita/channels) "Event channels in node.js" - ensures that ueberDB operations are atomic and in series for each key + # License [Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html)