Fix #690: Create README.md (#694)

README.md shows the name, release versions, description, features,
installation, method of building own version, contributing and license.

Author: ma8ma

README.md

@@ -0,0 +1,253 @@
+Vimperator-labs
+===============
+
+[![amo release][amo_version]][amo_release]
+[![github release][github_version]][github_release]
+
+**Make Firefox/Thunderbird look and behave like Vim**
+
+> **To beginners**: Welcome to the Vimperator-labs!  
+> This README isn't written usage and help for the add-on itself.
+> Try `:help` command after installing add-on for details.
+
+Description
+-----------
+
+See also [Home page][homepage].
+
+Writing efficient user interfaces is the main maxim, here at Vimperator labs.
+We often follow the Vim way of doing things, but extend its principles when
+necessary.  
+Towards this end, we've created the liberator library for Mozilla based
+applications, to encapsulate as many of these generic principles as possible,
+and liberate developers from the tedium of reinventing the wheel.
+
+Currently, these applications are using this library:
+
+### Vimperator
+
+Vimperator, the flagship project from Vimperator labs, creates a Vim-like
+Firefox.
+
+Vimperator is a Firefox browser extension with strong inspiration from the Vim
+text editor, with a mind towards faster and more efficient browsing.  It has
+similar key bindings and you could call it a modal web browser, as key bindings
+differ according to which mode you are in. For example, it has a special Hint
+mode, where you can follow links easily with the keyboard only.  Also most
+functionality is available as commands, typing `:back` will go back within the
+current page history, just like hitting the back button in the toolbar.
+
+### Muttator
+
+Muttator is to Thunderbird what Vimperator is to Firefox. Combines the best
+aspects of Vim and Mutt.
+
+Muttator is a free add-on for the Thunderbird mail client, which makes it look
+and behave like the Vim text editor. It has similar key bindings and you could
+call it a modal mail client, as key bindings differ according to which mode you
+are in. For example, it the same keys can select the next message while the
+message list has focus or can scroll down an existing message when the message
+preview is selected. It also adds commands for accessing most Thunderbird
+functionality. E.g., `:contact -lastname "Vimperator" [email protected]`
+will add Vimperator's mailing list to your address book.
+
+Features (Vimperator)
+---------------------
+
+- Vim-like keybindings (`h`, `j`, `k`, `l`, `gg`, `G`, `0`, `$`, `ZZ`, etc.)
+- Ex commands (`:quit`, `:open www.foo.com`, ...)
+- Tab completion available for all commands with support for 'longest' matching
+  when set in 'wildmode'
+- Extensions! Yes, you can extend Vimperator's functionality with scripts just
+  like you can extend Firefox with extensions
+- Explore JavaScript objects with `:echo window` and even context-sensitive tab
+  completion
+- Hit-a-hint like navigation of links (start with `f` to follow a link)
+- Advanced completion of bookmark and history URLs (searching also in title,
+  not only URL)
+- Vim-like statusline with a wget-like progress bar
+- Minimal GUI (easily hide useless menubar and toolbar with `:set guioptions=`)
+- Ability to `:source` JavaScript files, and to use a `~/.vimperatorrc` file
+- Easy quick searches (`:open foo` will search for "foo" in google, `:open ebay
+  terminator` will search for "terminator" on ebay) with support for Firefox
+  keyword bookmarks and search engines
+- Count supported for many commands (`3<C-o>` will go back 3 pages)
+- Beep on errors
+- Marks support (`ma` to set mark 'a' on a webpage, `'a` to go there)
+- QuickMarks support (quickly go to previously marked web pages with
+  `go{a-zA-Z0-9}`)
+- `:map` and `:command` support (and `feedkeys()` for script writers)
+- `:time` support for profiling
+- Move the text cursor and select text with vim keys and a visual mode
+- External editor support
+- Macros to replay key strokes
+- AutoCommands to execute action on certain events
+- A comprehensive `:help`, explaining all commands, mappings and options
+- Much more...
+
+Installation (Vimperator)
+-------------------------
+
+> Note that Vimperator doesn't support multi-process aka
+> [Electrolysis][wiki_e10s] (e10s), it's necessary to disable e10s to use the
+> add-on.
+
+- Download **signed** add-on from addons.mozilla.org (AMO) <sup>1</sup>
+
+  1. Enter [Add-ons page][amo_release].
+  2. Click `Continue to Download` button.
+  3. Click `Add to Firefox` button.
+
+- Download **unsigned** <sup>2</sup> add-on from github.com (Github)
+
+  1. Enter [Releases page][github_release].
+  2. Click `vimperator-3.N.N.xpi` link under Downloads topic.
+
+- Build own version (and signing)
+  See [Build own version](#build-own-version) topic.
+
+> <sup>1</sup> If the version on [AMO][amo_release] is older than the [latest
+> release][github_release], you can build your own version and use it until AMO
+> release is updated.
+
+> <sup>2</sup> Since version 48, installing add-on to Firefox has required
+> signing. Unsigned add-on is for Unbranded Builds. See [mozilla
+> wiki][wiki_signing].
+
+Build own version
+-----------------
+
+### Unsigned (for Unbranded Builds)
+
+See http://www.vimperator.org/developerinfo.
+
+### Signed (for Firefox 48+)
+
+Instructions for building this can be found in
+vimperator/private.properties.in. See also [MDN document][mdn_signing]
+(developer.mozilla.org) for details about signing and distribution.
+
+There are necessary four steps to use own version.
+
+1. Prepare "AMO API key" and "jpm" if first time
+2. Build unsigned add-on
+3. Submit unsigned add-on to AMO
+4. Install signed add-on to Firefox
+5. Addition: Use Command-line interface (CLI) to build and submit
+
+#### Prepare AMO API key and jpm
+
+- [AMO API key][amo_api_key] (require Firefox Account)
+- [jpm][jpm_repo] (require node.js):
+
+  ```bash
+  npm install -g jpm
+  ```
+
+#### Build unsigned add-on
+
+Clone repository and create private.properties:
+
+```bash
+git clone https://github.com/vimperator/vimperator-labs.git
+cd vimperator-labs/vimperator
+cp private.properties.in private.properties
+```
+
+Then edit private.properties so that it looks something like:
+
+```makefile
+VERSION       := $(VERSION).$(shell date '+%Y%m%d%H%M%S')
+UUID           = vimperator@<uniqueid> # e.g. vimperator@<yourdomain>
+AMO_API_KEY    = <your API key> # AKA "Issuer"
+AMO_API_SECRET = <your API secret>
+UPDATE_URL     =
+UPDATE_URL_XPI =
+```
+
+Then run:
+
+```bash
+make xpi
+```
+
+The unsigned XPI should appear in
+`../downloads/vimperator-3.N.N.yyyymmddhhmmss.xpi`.
+
+#### Submit unsigned add-on to AMO
+
+<table>
+<tr>
+  <th>Have you ever submitted own version to AMO?</th><th>How to submit</th>
+</tr>
+<tr>
+  <td>No, I'd like to register own version.</td>
+  <td>Enter <a
+  href="https://addons.mozilla.org/en-US/developers/addon/submit/distribution">
+  How to Distribute this Version</a>, upload the XPI selecting <code>On your
+  own</code> button.
+  </td>
+</tr>
+<tr>
+  <td>Yes, I'd like to update own version.</td>
+  <td>Enter <a href="https://addons.mozilla.org/en-US/developers/addons">
+  Manage My Submissions</a>, upload the XPI from your Vimperator's <code>New
+  Version</code> link.
+  </td>
+</tr>
+</table>
+
+Then the validation starts. Finally, automatically validation XPI finishes,
+click `Sign add-on` button to sign.
+
+#### Install signed add-on to Firefox
+
+Install it via the link in your AMO developer account (find your Vimperator's
+`Manage Status & Versions`). The new UUID makes it a new add-on, so don't
+forget to disable the old version.
+
+#### Use CLI to build and submit
+
+After once you signed the add-on, you are able to update the add-on using CLI.
+
+```bash
+cd vimperator-labs/vimperator
+make sign
+```
+
+Contributing
+------------
+
+**Vimperator is in need of collaborators! Help bring vimperator into the age
+of e10s!**
+
+Please check existing issues for similar issues before opening a new issue.
+See [CONTIRIBUTING.md][contributing] for details.
+
+License
+-------
+
+Vimperator-labs is released under the MIT license, see [License.txt][license].
+
+Links                | URL
+---------------------|---------------------------------------------------------
+Home page            | http://www.vimperator.org/
+Add-ons (Vimperator) | https://addons.mozilla.org/en-US/firefox/addon/vimperator/
+Add-ons (Muttator)   | https://addons.mozilla.org/en-US/firefox/addon/muttator/
+Github repository    | https://github.com/vimperator/vimperator-labs/
+
+<!-- References -->
+[amo_version]: https://img.shields.io/amo/v/vimperator.svg
+[amo_release]: https://addons.mozilla.org/en-US/firefox/addon/vimperator/
+[github_version]: https://img.shields.io/github/release/vimperator/vimperator-labs.svg
+[github_release]: https://github.com/vimperator/vimperator-labs/releases/latest
+[homepage]: http://www.vimperator.org/
+[wiki_e10s]: https://wiki.mozilla.org/Electrolysis
+[wiki_signing]: https://wiki.mozilla.org/Add-ons/Extension_Signing
+[mdn_signing]: https://developer.mozilla.org/en-US/Add-ons/Distribution
+[amo_api_key]: https://addons.mozilla.org/en-US/developers/addon/api/key/
+[jpm_repo]: https://github.com/mozilla-jetpack/jpm
+[contributing]: https://github.com/vimperator/vimperator-labs/blob/master/CONTRIBUTING.md
+[license]: https://github.com/vimperator/vimperator-labs/blob/master/License.txt
+
+<!-- vim: set ft=markdown sw=4 ts=4 sts=4 et ai: -->

vimperator/NEWS

@@ -1,4 +1,5 @@
 201x-xx-xx:
+    * create README.md
 
 
 2017-02-01: