Merge pull request #130 from MightyCreak/improve-docs

Improve README and documentation

CHANGELOG.md

@@ -14,6 +14,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Renamed POTFILES.in to POTFILES
 - Renamed io.github.mightycreak.Diffuse.metadata.xml.in to
   io.github.mightycreak.Diffuse.appdata.xml.in
+- Leaner README.md
+- Moved the documentation to docs/
 
 ## 0.7.3 - 2021-11-22
 
@@ -25,7 +27,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - main.py slimmed down by about 5000 lines
 - The new widgets.py is a bit fat though (~4000 lines)
-- Cleaned the README.md and moved the documentation to docs/
 
 ### Fixed
 - The intense code cleaning seems to have fixed a bug with the `-c` argument

README.md

@@ -1,4 +1,22 @@
-# Diffuse
+<h1 align="center">
+  <img src="data/icons/hicolor/scalable/apps/io.github.mightycreak.Diffuse.svg" alt="Diffuse" width="192" height="192"/><br/>
+  Diffuse
+</h1>
+
+<p align="center" style="margin-top: 2em">
+  <a href="https://flathub.org/apps/details/io.github.mightycreak.Diffuse">
+    <img width="200" alt="Download on Flathub" src="https://flathub.org/assets/badges/flathub-badge-en.png"/>
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/MightyCreak/diffuse/actions/workflows/main.yml">
+    <img src="https://github.com/MightyCreak/diffuse/actions/workflows/main.yml/badge.svg" alt="CI status"/>
+  </a>
+  <a href="https://repology.org/project/diffuse/versions">
+    <img src="https://repology.org/badge/tiny-repos/diffuse.svg" alt="Packaging status">
+  </a>
+</p>
 
 Diffuse is a graphical tool for merging and comparing text files.  Diffuse is
 able to compare an arbitrary number of files side-by-side and gives users the
@@ -18,14 +36,6 @@ Some key features of Diffuse:
 * Unlimited undo
 * Easy keyboard navigation
 
-## Installation
-
-This is the easiest way to install Diffuse:
-
-```sh
-flatpak install io.github.mightycreak.Diffuse
-```
-
 ## Documentation
 
 For a more detailed documentation for users, translators and developers, see

docs/developers.md

@@ -1,5 +1,13 @@
 # Developers documentation
 
+## Requirements
+
+Diffuse is implemented in Python and should run on any platform with Python and
+PyGObject.
+
+* Python >= 3.4
+* PyGObject >= 3.18
+
 ## Setup on Linux
 
 ### Build, test and install using Flatpak

docs/users.md

@@ -1,9 +1,24 @@
 # Users documentation
 
-## Requirements
+## Installation
 
-Diffuse is implemented in Python and should run on any platform with Python and
+### Using Flatpak
-PyGObject.
 
-* Python >= 3.4
+```sh
-* PyGObject >= 3.18
+flatpak install io.github.mightycreak.Diffuse
+```
+
+Flatpak is probably the easiest way to install Diffuse on any distribution and
+get the latest and greatest as quickly as possible. The Flatpak package is
+hosted on [Flathub](https://flathub.org).
+
+_Note:_ If the Flathub repository is not installed yet, please follow
+[these instructions](https://flatpak.org/setup/).
+
+### Using the distribution package manager
+
+The Diffuse package statuses for every distributions can been seen on
+[repology](https://repology.org/project/diffuse/versions).
+
+Huge thanks to [@bongochong](https://github.com/bongochong) for maintaining the
+Diffuse package on Fedora.