libre-service.eu/pad.libre-service.eu-etherpad
libre-service.eu/pad.libre-service.eu-etherpad
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-01-31 19:02:59 +01:00
Code Issues Projects Releases Wiki Activity

improve the README

Browse source
This commit is contained in:
Peter 'Pita' Martischka 2011-04-07 14:35:13 +01:00
parent 2d0dc5aab6
commit a8b91b9b40
2 changed files with 43 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README
View file

@ -1,40 +0,0 @@
Etherpad-Lite
What is Etherpad Lite?
Etherpad lite is a really-real time collaborative editor spawned from the Hell fire of Etherpad.
Why use Etherpad Lite?
* Tiny server hardware footprint
* Pure Javascript client and server side
* No nasty dependancies
* Simplfied interface
* Easy to embed
* 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
REQUIREMENTS
NoteJS - http://nodejs.org/ [apt-get install nodejs]
NPM[Node Package Manager] - http://npmjs.org [curl http://npmjs.org/install.sh | sh]
INSTALATION
1. apt-get install nodejs
2. curl http://npmjs.org/install.sh | sh
3. npm install socket.io
RUNNING
1. cd bin
2. ./run.sh
TESTING
1. Open your web browser and visit http://IPSERVER:9001

43
README.md Normal file
View file

@ -0,0 +1,43 @@
# Etherpad-Lite
What is Etherpad Lite?
Etherpad lite is a really-real time collaborative editor spawned from the Hell fire of Etherpad.
We're reusing the well tested Etherpad easysync library to make it really realtime. Etherpad Lite
is based on node.js what makes it much leigther and more stable than the original Etherpad. Our hope
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
# Why use Etherpad Lite?
* Tiny server hardware footprint
* Pure Javascript client and server side
* No nasty dependancies
* Simplfied interface
* Easy to embed
* 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
1. download latest node.js version from <http://nodejs.org/> and build it with this instructions <https://github.com/joyent/node/wiki/Installation>
2. install npm [curl http://npmjs.org/install.sh | sh]
3. install socket.io [npm install socket.io]
# Start
1. cd bin
2. ./run.sh
3. Open your web browser and visit http://IPSERVER:9001
# Contribute
Look at the TODO list at <https://github.com/Pita/etherpad-lite/wiki/TODO>
You can get in touch via petermartischka-at-googlemail.com
A mailinglist/irc channel will follow later