[Doc] Update documentation

setvisible · Jan 1, 2024 · 8e10a61 · 8e10a61
1 parent 57421ed
commit 8e10a61
Show file tree

Hide file tree

Showing 14 changed files with 48 additions and 38 deletions.
diff --git a/.tx/status.html b/.tx/status.html
@@ -1,23 +1,19 @@
 <!DOCTYPE html>
 <html>
-    <head>
-        <meta charset="utf-8">
-        <title>ArrowDL Overview</title>
-    </head>
-    <body>
-        <h1>Current Status</h1>
-        <p>Go to the <a href="https://www.transifex.com/arrowdl/arrowdl/widgets/">Translations effort</a> page on Transifex.</p>
-        <h2>List of supported languages and translation efforts</h2>
-        <p>
-            <img alt="Top translations" src="https://www.transifex.com/projects/p/arrowdl/resource/main-application/chart/image_png" />
-        </p>
-        <h2>Detailed chart</h2>
-        <p>
-            <section>
-                <script type="text/javascript" src="https://www.google.com/jsapi"></script>
-                <script type="text/javascript" src="https://www.transifex.com/_/charts/js/arrowdl/arrowdl/inc_js/main-application/"></script>
-                <div id="txchart-arrowdl-main-application">Loading chart...</div>
-            </section>       
-        </p>
-    </body>
+  <head>
+    <meta charset="utf-8">
+    <title>ArrowDL Overview</title>
+  </head>
+  <body>
+    <h1>Current Status</h1>
+    <p>Go to the <a href="https://www.transifex.com/arrowdl/arrowdl/widgets/">Translations effort</a> page on Transifex.</p>
+    <h2>supported languages and translation efforts</h2>
+    <p>
+      <section>
+        <script type="text/javascript" src="https://www.google.com/jsapi"></script>
+        <script type="text/javascript" src="https://app.transifex.com/_/charts/js/arrowdl/arrowdl/inc_js/main-application/"></script>
+        <div id="txchart-arrowdl-main-application">Loading chart...</div>
+      </section>       
+    </p>
+  </body>
 </html>
diff --git a/README.md b/README.md
@@ -1,35 +1,46 @@
-<img align="left" src="./src/resources/logo/icon64.png">
+<div align="center">
+     
+[![ArrowDL](./src/resources/logo/icon64.png)](#readme)
 
-# ArrowDL
+# ArrowDL (Arrow Downloader)
 
-[![GitHub release](https://img.shields.io/github/v/release/setvisible/arrowdl.svg)](../../releases/latest)
-[![GitHub license](https://img.shields.io/github/license/setvisible/arrowdl.svg)](LICENSE) 
-[![Chrome Web Store](https://img.shields.io/chrome-web-store/users/modofbhnhlagjmejdbalnijgncppjeio?label=users&logo=google)](https://chrome.google.com/webstore/detail/down-right-now/modofbhnhlagjmejdbalnijgncppjeio "Google Chrome Add-on")
-[![Mozilla Add-on](https://img.shields.io/amo/users/down-right-now?label=users&logo=mozilla)](https://addons.mozilla.org/firefox/addon/down-right-now/ "Mozilla Firefox Add-on")
-![GitHub All Releases](https://img.shields.io/github/downloads/setvisible/ArrowDL/total)
-[![Chocolatey package](https://img.shields.io/chocolatey/dt/arrowdl?color=blue&label=chocolatey%20package)](https://community.chocolatey.org/packages/arrowdl)
-[![Twitter Follow](https://img.shields.io/twitter/follow/ArrowDLApp?label=Follow)](https://twitter.com/ArrowDLApp)
+[![Release version](https://img.shields.io/github/v/release/setvisible/arrowdl?style=for-the-badge)](../../releases/latest)
+[![License](https://img.shields.io/github/license/setvisible/arrowdl.svg?style=for-the-badge)](LICENSE) 
+![GitHub All Releases](https://img.shields.io/github/downloads/setvisible/ArrowDL/total?style=for-the-badge)
 
+![Chrome Web Store Users](https://img.shields.io/chrome-web-store/users/modofbhnhlagjmejdbalnijgncppjeio?style=for-the-badge&label=users&logo=google&logoColor=white)
+[![Mozilla Add-on](https://img.shields.io/amo/users/down-right-now?style=for-the-badge&label=users&logo=mozilla&logoColor=white)](https://addons.mozilla.org/firefox/addon/down-right-now/ "Mozilla Firefox Add-on")
+[![Chocolatey](https://img.shields.io/chocolatey/dt/downzemall?style=for-the-badge&label=chocolatey%20package)](https://community.chocolatey.org/packages/downzemall)
 
-| master | develop |
-|---------|-----------|
-| [![Built with GitHub Actions](https://github.com/setvisible/ArrowDL/actions/workflows/deployment.yml/badge.svg?branch=master)](https://github.com/setvisible/ArrowDL/actions "Go to GitHub Actions") | [![Built with GitHub Actions](https://github.com/setvisible/arrowdl/actions/workflows/deployment.yml/badge.svg?branch=develop)](https://github.com/setvisible/ArrowDL/actions "Go to GitHub Actions") |
+![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/ArrowDLApp?style=for-the-badge&logo=x&label=Follow&logoColor=white)
 
+</div>
 
-*ArrowDL* is a rewrite of the legacy software [DownThemAll!](https://en.wikipedia.org/wiki/DownThemAll! "https://en.wikipedia.org/wiki/DownThemAll!") which was an extension for Mozilla Firefox, but whose development stopped around 2016, when Mozilla Firefox migrated to WebExtensions.
+## Overview
 
 *ArrowDL* is a standalone download manager for Windows, MacOS and Linux. 
 
 It aims to work with latest versions of Mozilla Firefox (powered by *WebExtensions*), and other web browsers (Chrome, Edge, Safari...). 
 
+
+## Development
+
 *ArrowDL* is written in C++ and based on the [Qt](https://www.qt.io/ "https://www.qt.io/") framework.
 
-[![Built with Qt](./screenshots/built_with_qt.png)](https://www.qt.io/ "Go to Qt official site - www.qt.io")
+| master | develop |
+|---------|-----------|
+| [![Built with GitHub Actions](https://github.com/setvisible/ArrowDL/actions/workflows/deployment.yml/badge.svg?style=for-the-badge&branch=master)](https://github.com/setvisible/ArrowDL/actions "Go to GitHub Actions") | [![Built with GitHub Actions](https://github.com/setvisible/arrowdl/actions/workflows/deployment.yml/badge.svg?style=for-the-badge&branch=develop)](https://github.com/setvisible/ArrowDL/actions "Go to GitHub Actions") |
 
 
 ## Screenshots
 
-<details open="">
+<details>
+<summary>Overview</summary>
+
+![ArrowDL](./screenshots/screenshot.png)
+
+</details>
+<details>
 <summary>Video Streams</summary>
 
 ![Video Download](./screenshots/anim_youtube.gif)

diff --git a/TRANSLATORS.md b/TRANSLATORS.md
@@ -144,6 +144,8 @@ Then the *.ts files are synchronized with the C++ code.
 
 Use the TX Client to push and pull translations to and from Transifex:
 
+[Download the Transifex Client](https://github.com/transifex/cli/releases/latest/)
+
 > You need `tx` (see Transifex documentation to [install](https://docs.transifex.com/client/installing-the-client) it)
 
 

diff --git a/docs/category/download-advanced.md b/docs/category/download-advanced.md
@@ -59,7 +59,7 @@ Choose the browser:
 
 The latest release is available [here](https://github.com/setvisible/ArrowDL/releases/latest)
 
-[![GitHub release](https://img.shields.io/github/v/release/setvisible/arrowdl.svg)](https://github.com/setvisible/ArrowDL/releases/latest)
+[![GitHub release](https://img.shields.io/github/v/release/setvisible/arrowdl.svg?style=for-the-badge)](https://github.com/setvisible/ArrowDL/releases/latest)
 
 
 ### Choose your plateform<a name="download-plateform"></a>
@@ -79,9 +79,10 @@ The next table explains the differences between the packages.
 - <a href="https://github.com/setvisible/ArrowDL/releases/latest/" id="id_windows_msvc_x86" >ArrowDL <span class="version-text">v0.0.0</span> for Windows (Portable, MSVC, 32 bit)</a>
 {% endcomment %}
 
-[^1]: Prefer the MSVC version if you are on Windows.
-      It uses the *Chromium* engine that parses HTML *and* Javascript.
+[^1]: The MSVC version uses the *Chromium* engine that parses HTML *and* Javascript.
       The MinGW version is more basic, it uses *Google Gumbo*, that parses HTML only, not Javascript.
+      Note: The MSVC version has been decommissioned on Windows, only GCC (aka MinGW) remains.
+      Maintaining 2 builds was really time-consuming.
 
 
 #### Linux<a name="download-plateform-unix"></a>[^2]

diff --git a/screenshots/built_with_qt.png b/screenshots/built_with_qt.png
diff --git a/screenshots/promo_1400x560.png b/screenshots/promo_1400x560.png
diff --git a/screenshots/promo_330x43.png b/screenshots/promo_330x43.png
diff --git a/screenshots/promo_440x280.png b/screenshots/promo_440x280.png
diff --git a/screenshots/promo_920x680.png b/screenshots/promo_920x680.png
diff --git a/screenshots/screenshot.png b/screenshots/screenshot.png
diff --git a/screenshots/screenshot_01_1280x800.png b/screenshots/screenshot_01_1280x800.png
diff --git a/screenshots/screenshot_02_1280x800.png b/screenshots/screenshot_02_1280x800.png
diff --git a/screenshots/screenshot_03_1280x800.png b/screenshots/screenshot_03_1280x800.png
diff --git a/screenshots/screenshot_04_1280x800.png b/screenshots/screenshot_04_1280x800.png