Beautify README (#80)

Because: - makes the project more appealing - provides a better overview of the project
echebbi · May 1, 2020 · b546ae5 · b546ae5
1 parent 799ebfa
commit b546ae5
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -1,42 +1,74 @@
-# Discord Rich Presence for Eclipse IDE
+<h1 align="center">
+  Discord Rich Presence for Eclipse IDE
+</h1>
+<p align="center">
+	<i>Show the world the projects you're working on!</i>
+</p>
 
-[![Build Status](https://travis-ci.org/echebbi/eclipse-discord-integration.svg?branch=master)](https://travis-ci.org/echebbi/eclipse-discord-integration) [![Documentation Status](https://readthedocs.org/projects/discord-rich-presence-for-eclipse-ide/badge/?version=latest)](https://discord-rich-presence-for-eclipse-ide.readthedocs.io/en/latest/?badge=latest) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=fr.kazejiyu.discord.rpc.integration%3Afr.kazejiyu.discord.rpc.integration.root&metric=sqale_index)](https://sonarcloud.io/dashboard?id=fr.kazejiyu.discord.rpc.integration%3Afr.kazejiyu.discord.rpc.integration.root) [![codecov](https://codecov.io/gh/echebbi/eclipse-discord-integration/branch/master/graph/badge.svg)](https://codecov.io/gh/echebbi/eclipse-discord-integration) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=fr.kazejiyu.discord.rpc.integration%3Afr.kazejiyu.discord.rpc.integration.root&metric=ncloc)](https://sonarcloud.io/dashboard?id=fr.kazejiyu.discord.rpc.integration%3Afr.kazejiyu.discord.rpc.integration.root) [![Eclipse Marketplace](https://img.shields.io/badge/Eclipse-Marketplace-blue.svg?longCache=true&style=flat&logo=eclipse)](https://marketplace.eclipse.org/content/discord-rich-presence-eclipse-ide) [ ![Download](https://api.bintray.com/packages/kazejiyu/eclipse-discord-integration/releases/images/download.svg) ](https://bintray.com/kazejiyu/eclipse-discord-integration/releases/_latestVersion)
-
-## Presentation
+<div align="center">
 
-Discord Rich Presence for Eclipse IDE is a plug-in that uses [Rich Presence](https://discordapp.com/rich-presence) in order to display information related to your current work in Discord.
+[![Build Status](https://travis-ci.org/echebbi/eclipse-discord-integration.svg?branch=master)](https://travis-ci.org/echebbi/eclipse-discord-integration) [![Documentation Status](https://readthedocs.org/projects/discord-rich-presence-for-eclipse-ide/badge/?version=latest)](https://discord-rich-presence-for-eclipse-ide.readthedocs.io/en/latest/?badge=latest) <a href="https://dl.bintray.com/kazejiyu/eclipse-discord-integration/updates/"><img alt="p2 update site" src="https://img.shields.io/website?label=p2&logo=p2%20update%20site&up_message=available&url=https:%2F%2Fdl.bintray.com%2Fkazejiyu%2Feclipse-discord-integration%2Fupdates%2F"></a> [![Eclipse Marketplace](https://img.shields.io/badge/Eclipse-Marketplace-blue.svg?longCache=true&style=flat&logo=eclipse)](https://marketplace.eclipse.org/content/discord-rich-presence-eclipse-ide)
+<br/>
+[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=fr.kazejiyu.discord.rpc.integration%3Afr.kazejiyu.discord.rpc.integration.root&metric=sqale_index)](https://sonarcloud.io/dashboard?id=fr.kazejiyu.discord.rpc.integration%3Afr.kazejiyu.discord.rpc.integration.root) [![codecov](https://codecov.io/gh/echebbi/eclipse-discord-integration/branch/master/graph/badge.svg)](https://codecov.io/gh/echebbi/eclipse-discord-integration)
 
-Here is an example of the Rich Presence Integration:
+</div>
 
 <div align="center">
-  <img alt="Example of Rich Presence Integration" src="docs/images/rich_presence_example.png"/>
+  <img alt="Example of Rich Presence Integration" src="docs/images/rich-presence-examples.gif"/>
 </div>
 
-> **!** Please [take a look at the documentation](https://discord-rich-presence-for-eclipse-ide.readthedocs.io/en/latest/) for further information about installation, use and customizations.
+<br/>
 
-## Installation
+_Discord Rich Presence for Eclipse IDE_ is a plug-in that uses [Rich Presence](https://discordapp.com/rich-presence) in order to display information related to your current work in Discord.
 
-### From the update site
-The plug-in can be installed from the following update site:
+## Main Features:
 
-- [https://dl.bintray.com/kazejiyu/eclipse-discord-integration/updates/](https://dl.bintray.com/kazejiyu/eclipse-discord-integration/updates/)
+<p>
+  	<ul>
+	  	<li align="justify"><strong>Exposure</strong>: have a great project? <a href="#Installation">Show it to the world!</a></li>
+	  	<li align="justify"><strong>Customization</strong>: don't like the wording or the icons? <a href="https://discord-rich-presence-for-eclipse-ide.readthedocs.io/en/latest/customize/change-wording.html">Provide your own!</a></li>
+	  	<li align="justify"><strong>Extensibility</strong>: have a custom Eclipse editor? <a href="https://discord-rich-presence-for-eclipse-ide.readthedocs.io/en/latest/extend/support-new-editors.html"/>We can support it!</a></li>
+		  <li align="justify"><strong>Privacy</strong>: working on a secret project? <a href="https://discord-rich-presence-for-eclipse-ide.readthedocs.io/en/latest/customize/hide-information.html">Show only what you want!</a></li>
+	</ul>
+</p>
 
-To use it from Eclipse IDE, click on `Help` > `Install new software...` and then paste the above URL.
+Please [take a look at the documentation](https://discord-rich-presence-for-eclipse-ide.readthedocs.io/en/latest/) for further information about installation, use and customizations.
 
-### From the Eclipse Marketplace
+## Usage
 
-The plug-in is also available in the [Eclipse Marketplace](https://marketplace.eclipse.org/content/discord-rich-presence-eclipse-ide).
+Discord will automatically be notified as soon as the plug-in is installed. The plug-in can be deactivated from the Eclipse's Preferences (`Window` > `Preferences` > `Discord Rich Presence` > Uncheck _Activate Rich Presence Integration_).
+
+## Installation
+
+The plug-in is available in the [Eclipse Marketplace](https://marketplace.eclipse.org/content/discord-rich-presence-eclipse-ide).
 
 Drag the following button to your running Eclipse workspace to start the installation:
 <div align="center">
   <a href="http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=4240174" class="drag" title="Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client"><img typeof="foaf:Image" class="img-responsive" src="https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.png" alt="Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client" /></a>
 </div>
 
+<details>
+  <summary><b>Or show how to install it manually</b></summary>
+
+  1. Open Eclipse IDE
+  2. Go to *Help > Install New Software...*
+  3. Copy the update site’s URL in the *Work with* textbox:
+     	- https://dl.bintray.com/kazejiyu/eclipse-discord-integration/updates/
+  4. Hit *Enter* and wait for the list to load
+  5. Check *Action Language for EMF*
+  6. Click *Next* then *Finish*
+</details>
+
 ## Troubleshooting
 
 ### Discord does not detect Eclipse IDE as a game
 
-If Discord is not showing anything, ensure that Eclipse IDE is detected as a game. To this end, open Discord `User Settings` then go the `Games` tab. Click on the `Add it!` button and then select Eclipse IDE.
+If Discord is not showing anything, ensure that Eclipse IDE is detected as a game:
+
+1. Open Discord's `User Settings`
+2. Go the `Games` tab
+3. Click on the `Add it!` button
+4. Select Eclipse IDE
 
 ### A 'Workbench early startup error' occurs since the plug-in is installed
 
@@ -48,32 +80,39 @@ There is an incompatible JNA native library installed on this system
 Expected: 5.1.0
 Found: 4.0.1
 ```
-you can try to modify the _eclipse.ini_ file which is located next to _eclipse.exe_ in order to set the `jna.nosys` property to true as follows:
+modify the _eclipse.ini_ file (located next to _eclipse.exe_) to set the `jna.nosys` property to true:
 ```
 -vmargs
 -Djna.nosys=true
 ```
 
-> The `-vmargs` line should already exist, otherwise you can append it at the end of the file.
+> :information_source: The `-vmargs` line should already exist, otherwise you can append it at the end of the file.
 
-## Deactivate Discord Rich Presence
+## Changelog
 
-Once the plug-in is installed, Discord Rich Presence is automatically started on Eclipse startup. As a result, Discord displays **Playing Eclipse IDE** as a status message as soon as Eclipse IDE is opened. This behavior may not be desirable but can be easily deactivated.
+See [CHANGELOG.md](CHANGELOG.md).
 
-1. Open Eclipse Preferences (`Window` > `Preferences`)
-2. Open the plug-in's page (`Discord Rich Presence`)
-3. Uncheck _Activate Rich Presence Integration_
-4. Click on _Apply_
+## Contributing
 
-From that time on, Discord won't be notified anymore by Eclipse IDE. In order to re-activate Rich Presence, follow the steps above and check _Activate Rich Presence Integration_ again.
+<details>
+  <summary><b>Setup your dev environment</b></summary>
 
-## Changelog
+  1. Download the latest _[Eclipse IDE for RCP Developers](https://www.eclipse.org/downloads/packages/)_ release
+  2. Clone the repository `git clone https://github.com/echebbi/eclipse-discord-integration.git`
+  3. Import all projects in Eclipse IDE
+  4. Open the `releng/*.target/*.target` file
+  5. Click on *Set as Target Platform*
+  6. Wait for the dependencies to be loaded
+</details>
 
-See [CHANGELOG.md](CHANGELOG.md).
+<details>
+  <summary><b>Technical documentation</b></summary>
 
-## Contributing
+  <br/>
+  &emsp;&emsp;Plug-in's architecture is presented in [CONTRIBUTING.md/how-is-the-plug-in-architected](https://github.com/echebbi/eclipse-discord-integration/blob/master/CONTRIBUTING.md#how-is-the-plug-in-architected).
+</details>
 
-See [CONTRIBUTING.md](CONTRIBUTING.md).
+See [CONTRIBUTING.md](CONTRIBUTING.md) for further details.
 
 ## License
 

diff --git a/docs/images/rich-presence-examples.gif b/docs/images/rich-presence-examples.gif
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,7 +5,7 @@ Discord Rich Presence for Eclipse IDE
 
 The *Discord Rich Presence for Eclipse IDE* is a plug-in for Eclipse IDE that shows on Discord the projects and files you're currently working on:
 
-.. image:: images/rich_presence_example.png
+.. image:: images/rich-presence-examples.gif
     :align: center
     :alt: an example of Rich Presence shown in Discord