From decfdb6abea84df81467b2433f5164bc3cb9a909 Mon Sep 17 00:00:00 2001 From: muxator Date: Sun, 20 Oct 2019 00:40:18 +0200 Subject: [PATCH] readme: language revision. Removed stale info. Tried to simplify the document, to reduce unneded info, and to use a less informal language. For example, the introductory links describing git made sense 10 years ago. Today they are not needed to understand what Etherpad is. And mercurial was always better than git, anyways :) The mailing list and the IRC channel seem pretty dead by now. Let's just move everything to Github issues, which was the de facto situation anyways. About the donation links: I am the maintainer, and I do not know the identity of the owners of the donation links, so it is correct to remove them. The same was done on the website three months ago: https://github.com/ether/ether.github.com/commit/d4ef04605da5 --- CONTRIBUTING.md | 1 - README.md | 45 ++++++++++++++++----------------------------- src/package.json | 2 +- 3 files changed, 17 insertions(+), 31 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3137386cc..724e02ac0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -130,5 +130,4 @@ Etherpad is much more than software. So if you aren't a developer then worry no * Co-Author and Publish CVEs * Work with SFC to maintain legal side of project * Maintain TODO page - https://github.com/ether/etherpad-lite/wiki/TODO#IMPORTANT_TODOS - * Replying to messages on IRC / The Mailing list / Emails diff --git a/README.md b/README.md index 6205ae3c5..9430e86bc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# A really-real time collaborative word processor for the web -![Demo Etherpad Animated Jif](https://i.imgur.com/zYrGkg3.gif "Etherpad in action on PrimaryPad") +# A real-time collaborative editor for the web +![Demo Etherpad Animated Jif](https://i.imgur.com/zYrGkg3.gif "Etherpad in action") # About -Etherpad is a really-real time collaborative editor scalable to thousands of simultaneous real time users. Unlike all other collaborative tools Etherpad provides full fidelity data export and portability making it fully GDPR compliant. +Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on _your_ server, under _your_ control. **[Try it out](https://beta.etherpad.org)** @@ -11,14 +11,16 @@ Etherpad is a really-real time collaborative editor scalable to thousands of sim ## Requirements - `nodejs` >= **8.9.0** -## Uber-Quick Ubuntu +## GNU/Linux and other UNIX-like systems + +### Quick install on Debian/Ubuntu ``` -curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash - -sudo apt-get install -y nodejs +curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash - +sudo apt install -y nodejs git clone --branch master https://github.com/ether/etherpad-lite.git && cd etherpad-lite && bin/run.sh ``` -## GNU/Linux and other UNIX-like systems +### Manual install You'll need git and [node.js](https://nodejs.org) installed (minimum required Node version: **8.9.0**). **As any user (we recommend creating a separate user called etherpad):** @@ -34,19 +36,19 @@ To update to the latest released version, execute `git pull origin`. The next st ## Windows ### Prebuilt Windows package -This package works out of the box on any windows machine, but it's not very useful for developing purposes... +This package runs on any Windows machine, but for development purposes, please do a manual install. 1. [Download the latest Windows package](https://etherpad.org/#download) 2. Extract the folder -Now, run `start.bat` and open in your browser. You like it? [Next steps](#next-steps). +Run `start.bat` and open in your browser. You like it? [Next steps](#next-steps). ### Manually install on Windows You'll need [node.js](https://nodejs.org) and (optionally, though recommended) git. 1. Grab the source, either - download - - or `git clone --branch master https://github.com/ether/etherpad-lite.git` (for this you need git, obviously) + - or `git clone --branch master https://github.com/ether/etherpad-lite.git` 2. start `bin\installOnWindows.bat` Now, run `start.bat` and open in your browser. @@ -66,9 +68,9 @@ 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 instances from the same installation. Similarly, `--credentials` can be used to give a settings override file, `--apikey` to give a different APIKEY.txt file and `--sessionkey` to give a non-default SESSIONKEY.txt. **Each configuration parameter can also be set via an environment variable**, using the syntax `"${ENV_VAR}"` or `"${ENV_VAR:default_value}"`. For details, refer to `settings.json.template`. -Once you have access to your /admin section settings can be modified through the web browser. +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-in a production environment, since the "dirtyDB" database driver is only for testing and/or development purposes. +If you are planning to use Etherpad in a production environment, you should use a dedicated database such as `mysql`, since the `dirtyDB` database driver is only for testing and/or development purposes. ## Secure your installation If you have enabled authentication in `users` section in `settings.json`, it is a good security practice to **store hashes instead of plain text passwords** in that file. This is _especially_ advised if you are running a production installation. @@ -88,10 +90,6 @@ Documentation can be found in `doc/`. # Development ## Things you should know -Understand [git](https://training.github.com/) and watch this [video on getting started with Etherpad Development](https://youtu.be/67-Q26YH97E). - -If you're new to node.js, start with Ryan Dahl's [Introduction to Node.js](https://youtu.be/jo_B4LTHi3I). - 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). @@ -100,11 +98,7 @@ If you want to find out how Etherpad's `Easysync` works (the library that makes Read our [**Developer Guidelines**](https://github.com/ether/etherpad-lite/blob/master/CONTRIBUTING.md) # Get in touch -[mailinglist](https://groups.google.com/group/etherpad-lite-dev) -[#etherpad-lite-dev freenode IRC](https://webchat.freenode.net?channels=#etherpad-lite-dev)! - -# Languages -Etherpad is written in JavaScript on both the server and client so it's easy for developers to maintain and add new features. +The official channel for contacting the development team is via the [Github issues](https://github.com/ether/etherpad-lite/issues). # HTTP API Etherpad is designed to be easily embeddable and provides a [HTTP API](https://github.com/ether/etherpad-lite/wiki/HTTP-API) @@ -114,7 +108,7 @@ that allows your web application to manage pads, users and groups. It is recomme There is a [jQuery plugin](https://github.com/ether/etherpad-lite-jquery-plugin) that helps you to embed Pads into your website. # Plugin Framework -Etherpad offers a plugin framework, allowing you to easily add your own features. By default your Etherpad is extremely light-weight and it's up to you to customize your experience. Once you have Etherpad installed you should visit the plugin page and take control. +Etherpad offers a plugin framework, allowing you to easily add your own features. By default your Etherpad is extremely light-weight and it's up to you to customize your experience. Once you have Etherpad installed you should visit the plugin page and take control. # Translations / Localizations (i18n / l10n) Etherpad comes with translations into all languages thanks to the team at TranslateWiki. @@ -122,12 +116,5 @@ Etherpad comes with translations into all languages thanks to the team at Transl # FAQ Visit the **[FAQ](https://github.com/ether/etherpad-lite/wiki/FAQ)**. -# Donate! -* [Flattr](https://flattr.com/thing/71378/Etherpad-Foundation) -* Paypal - Press the donate button on [etherpad.org](https://etherpad.org) -* [Bitcoin](https://coinbase.com/checkouts/1e572bf8a82e4663499f7f1f66c2d15a) - -All donations go to the Etherpad foundation which is part of Software Freedom Conservency - # License [Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html) diff --git a/src/package.json b/src/package.json index 8c8c3e3d7..ac1fd09e0 100644 --- a/src/package.json +++ b/src/package.json @@ -1,6 +1,6 @@ { "name": "ep_etherpad-lite", - "description": "A Etherpad based on node.js", + "description": "A free and open source realtime collaborative editor", "homepage": "https://etherpad.org", "keywords": [ "etherpad",