From 4f07f829db0ac9adf5d6b2c6a0707d218d176c99 Mon Sep 17 00:00:00 2001 From: John McLear Date: Thu, 4 Apr 2013 01:20:46 +0100 Subject: [PATCH 1/6] new readme --- README.md | 47 ++++++++++++----------------------------------- 1 file changed, 12 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 291ecaeeb..d437646f2 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,13 @@ -# Making collaborative editing the standard on the web +# Really Real-Time Collaborative Editor +![alt text](http://primarypad.com/files/2012/11/PrimaryPad1.jpg "Etherpad in action on PrimaryPad") # About -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 ergo is much lighter and more stable than the original Etherpad. Our hope -is that this will encourage more users to use and install a realtime collaborative editor. A smaller, manageable and well -documented codebase makes it easier for developers to improve the code and contribute towards the project. - -**Etherpad vs Etherpad lite** - - - - - - - - - - - - - - - - -
 EtherpadEtherpad Lite
Size of the folder (without git history)30 MB1.5 MB
Languages used server sideJavascript (Rhino), Java, ScalaJavascript (node.js)
Lines of server side Javascript code~101k~9k
RAM Usage immediately after start257 MB (grows to ~1GB)16 MB (grows to ~30MB)
- - -Etherpad Lite is designed to be easily embeddable and provides a [HTTP API](https://github.com/ether/etherpad-lite/wiki/HTTP-API) +Etherpad is a really-real time collaborative editor maintained by the Etherpad Community. +Etherpad is written in Javascript(99.9%) on both the server and client so it's easy for developers to maintain and add new features. Because of this Etherpad has tons of customizations that you can leverage. +Etherpad is designed to be easily embeddable and provides a [HTTP API](https://github.com/ether/etherpad-lite/wiki/HTTP-API) that allows your web application to manage pads, users and groups. It is recommended to use the [available client implementations](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries) in order to interact with this API. There is also a [jQuery plugin](https://github.com/ether/etherpad-lite-jquery-plugin) that helps you to embed Pads into your website. -There's also a full-featured plugin framework, allowing you to easily add your own features. -Finally, Etherpad Lite comes with translations into tons of different languages! +There's also a full-featured plugin framework, allowing you to easily add your own features. By default your Etherpad is rather sparce and because Etherpad takes a lot of it's inspiration from Wordpress plugins are really easy to install and update. Once you have Etherpad installed you should visit the plugin page and take control. +Finally, Etherpad comes with translations into most languages! Users are automatically delivered the correct language for their local settings. **Visit [beta.etherpad.org](http://beta.etherpad.org) to test it live** @@ -86,9 +63,9 @@ You like it? [Next steps](#next-steps). # Next Steps ## Tweak the settings -You can modify the settings in `settings.json`. (If you need to handle multiple settings files, you can pass the path to a settings file to `bin/run.sh` using the `-s|--settings` option. This allows you to run multiple Etherpad Lite instances from the same installation.) +You can initially modify the settings in `settings.json`. (If you need to handle multiple settings files, you can pass the path to a settings file to `bin/run.sh` using the `-s|--settings` option. This allows you to run multiple Etherpad instances from the same installation.) Once you have access to your /admin section settings can be modified through the web browser. -You should use a dedicated database such as "mysql", if you are planning on using etherpad-lite in a production environment, since the "dirtyDB" database driver is only for testing and/or development purposes. +You should use a dedicated database such as "mysql", if you are planning on using etherpad-in a production environment, since the "dirtyDB" database driver is only for testing and/or development purposes. ## Helpful resources The [wiki](https://github.com/ether/etherpad-lite/wiki) is your one-stop resource for Tutorials and How-to's, really check it out! Also, feel free to improve these wiki pages. @@ -98,11 +75,11 @@ Documentation can be found in `docs/`. # Development ## Things you should know -Read this [git guide](http://learn.github.com/p/intro.html) and watch this [video on getting started with Etherpad Lite Development](http://youtu.be/67-Q26YH97E). +Read this [git guide](http://learn.github.com/p/intro.html) and watch this [video on getting started with Etherpad Development](http://youtu.be/67-Q26YH97E). If you're new to node.js, start with Ryan Dahl's [Introduction to Node.js](http://youtu.be/jo_B4LTHi3I). -You can debug Etherpad lite using `bin/debugRun.sh`. +You can debug Etherpad using `bin/debugRun.sh`. If you want to find out how Etherpad's `Easysync` works (the library that makes it really realtime), start with this [PDF](https://github.com/ether/etherpad-lite/raw/master/doc/easysync/easysync-full-description.pdf) (complex, but worth reading). @@ -114,7 +91,7 @@ Look at the [TODO list](https://github.com/ether/etherpad-lite/wiki/TODO) and ou Also, and most importantly, read our [**Developer Guidelines**](https://github.com/ether/etherpad-lite/blob/master/CONTRIBUTING.md), really! # Get in touch -Join the [mailinglist](http://groups.google.com/group/etherpad-lite-dev) and make some noise on our freenode irc channel [#etherpad-lite-dev](http://webchat.freenode.net?channels=#etherpad-lite-dev)! +Join the [mailinglist](http://groups.google.com/group/etherpad-lite-dev) and make some noise on our busy freenode irc channel [#etherpad-lite-dev](http://webchat.freenode.net?channels=#etherpad-lite-dev)! # Modules created for this project From 2003dd832721d418d873811f3e6a675166481087 Mon Sep 17 00:00:00 2001 From: John McLear Date: Thu, 4 Apr 2013 01:22:46 +0100 Subject: [PATCH 2/6] line breaks --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d437646f2..ec04b2d88 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ # About Etherpad is a really-real time collaborative editor maintained by the Etherpad Community. + Etherpad is written in Javascript(99.9%) on both the server and client so it's easy for developers to maintain and add new features. Because of this Etherpad has tons of customizations that you can leverage. + Etherpad is designed to be easily embeddable and provides a [HTTP API](https://github.com/ether/etherpad-lite/wiki/HTTP-API) that allows your web application to manage pads, users and groups. It is recommended to use the [available client implementations](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries) in order to interact with this API. There is also a [jQuery plugin](https://github.com/ether/etherpad-lite-jquery-plugin) that helps you to embed Pads into your website. There's also a full-featured plugin framework, allowing you to easily add your own features. By default your Etherpad is rather sparce and because Etherpad takes a lot of it's inspiration from Wordpress plugins are really easy to install and update. Once you have Etherpad installed you should visit the plugin page and take control. From a677286a401758aa80004900a3b8710aaf86cd94 Mon Sep 17 00:00:00 2001 From: John McLear Date: Thu, 4 Apr 2013 01:24:09 +0100 Subject: [PATCH 3/6] line breaks 2 --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ec04b2d88..553f7cf9a 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,12 @@ Etherpad is a really-real time collaborative editor maintained by the Etherpad C Etherpad is written in Javascript(99.9%) on both the server and client so it's easy for developers to maintain and add new features. Because of this Etherpad has tons of customizations that you can leverage. Etherpad is designed to be easily embeddable and provides a [HTTP API](https://github.com/ether/etherpad-lite/wiki/HTTP-API) -that allows your web application to manage pads, users and groups. It is recommended to use the [available client implementations](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries) in order to interact with this API. There is also a [jQuery plugin](https://github.com/ether/etherpad-lite-jquery-plugin) that helps you to embed Pads into your website. +that allows your web application to manage pads, users and groups. It is recommended to use the [available client implementations](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries) in order to interact with this API. + +There is also a [jQuery plugin](https://github.com/ether/etherpad-lite-jquery-plugin) that helps you to embed Pads into your website. + There's also a full-featured plugin framework, allowing you to easily add your own features. By default your Etherpad is rather sparce and because Etherpad takes a lot of it's inspiration from Wordpress plugins are really easy to install and update. Once you have Etherpad installed you should visit the plugin page and take control. + Finally, Etherpad comes with translations into most languages! Users are automatically delivered the correct language for their local settings. **Visit [beta.etherpad.org](http://beta.etherpad.org) to test it live** From a3136d778dc96c720f613ad09061c7aba04c0a55 Mon Sep 17 00:00:00 2001 From: John McLear Date: Thu, 4 Apr 2013 01:56:36 +0100 Subject: [PATCH 4/6] animated image prolly wont work --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 553f7cf9a..868eab324 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Really Real-Time Collaborative Editor -![alt text](http://primarypad.com/files/2012/11/PrimaryPad1.jpg "Etherpad in action on PrimaryPad") +![alt text](http://i.imgur.com/zYrGkg3.gif "Etherpad in action on PrimaryPad") # About Etherpad is a really-real time collaborative editor maintained by the Etherpad Community. From 43f877824136a8b64d0201def90d30406fd99384 Mon Sep 17 00:00:00 2001 From: John McLear Date: Thu, 4 Apr 2013 15:35:19 +0100 Subject: [PATCH 5/6] hrm, maybe this makes sense to a wider audience --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 868eab324..6354d9b06 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Really Real-Time Collaborative Editor +# A really-real time collaborative word processor for the web ![alt text](http://i.imgur.com/zYrGkg3.gif "Etherpad in action on PrimaryPad") # About From 5fb5b6c7afb9bec34162073f713b4cbdc1c421c5 Mon Sep 17 00:00:00 2001 From: John McLear Date: Thu, 4 Apr 2013 18:23:56 +0100 Subject: [PATCH 6/6] Linux clarity --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6354d9b06..db673468a 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Update to the latest version with `git pull origin`, then run `bin\installOnWind [Next steps](#next-steps). -## Linux/Unix +## GNU/Linux and other UNIX-like systems You'll need gzip, git, curl, libssl develop libraries, python and gcc. *For Debian/Ubuntu*: `apt-get install gzip git-core curl python libssl-dev pkg-config build-essential` *For Fedora/CentOS*: `yum install gzip git-core curl python openssl-devel && yum groupinstall "Development Tools"`