mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-20 15:36:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 27

Updated the README

Browse source
This commit is contained in:
Peter 'Pita' Martischka 2011-05-28 21:13:35 +01:00
parent aac1e25c9e
commit c3eb124bd7
1 changed files with 4 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -6,32 +6,19 @@ is that this will encourage more users to install a realtime collaborative edito
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
Visit <http://pitapoison.de:9001> to test it lives Visit <http://pitapoison.de:9001> to test it live
# Why use Etherpad Lite? # Why use Etherpad Lite?
* Tiny server hardware footprint * Tiny server hardware footprint
* Pure Javascript client and server side * Pure Javascript client and server side
* No nasty dependancies
* Simplfied interface * Simplfied interface
* Easy to embed * Easy to embed
* Well documented * Well documented
* Better support for third party editors
# What isn't available YET when compared to Etherpad?
* Timeslider
* Import/Export
* Clear authorship colours
* Upload files
* View Saved revisions
* Chat
* Pad management
* User management
* Plugin framework
# 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 `apt-get install libsqlite3-dev` 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` 4. install etherpad-lite `npm install -g ep-lite`
5. start with `ep-lite` 5. start with `ep-lite`
6. Open your web browser and visit <http://localhost:9001> 6. Open your web browser and visit <http://localhost:9001>
@ -41,9 +28,8 @@ Look at the TODO list at <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 You can join the mailinglist <http://groups.google.com/group/etherpad-lite-dev> or go to the freenode irc channel #etherpad-lite-dev
# Debug # Debug
1. cd bin 1. cd bin/runDebug.sh
2. ./runDebug.sh 2. Open Safari or Chrome and visit http://IPSERVER:8080
3. Open your webkit browser and visit http://IPSERVER:8080
# 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>