Merge pull request #18

elB4RTO · Dec 7, 2022 · 49a1df9 · 49a1df9
2 parents 66f3105 + a1bc4fc
commit 49a1df9
Show file tree

Hide file tree

Showing 2 changed files with 112 additions and 70 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -22,7 +22,7 @@ If you want to contribute to LogDoctor, please follow these steps:
 
   - **Improve** it with your ideas
 
-  - Submit a **Pull Request** to the origin branch, namely `elB4RTO/devel`
+  - Submit a **Pull Request** to the origin branch, namely `elB4RTO/LogDoctor:devel`
 
 <br/>
 
@@ -36,16 +36,16 @@ When submitting a PR, please follow the template.
 
 You have two ways of doing it:
 
-  - while forking:
-    - **uncheck** the "*Only copy the main branch*" option
+- while forking:
+  - **uncheck** the "*Only copy the main branch*" option
 
-  *or*
+*or*
 
-  - alternatively, you can do it afterwards:
-    - step in your copy of the repository
-    - select `branches` or click on `main` and select "*View all branches*"
-    - tap `New branch`
-    - insert the name you please and select `elB4RTO/devel` as branch source
+- alternatively, you can do it afterwards:
+  - step in your fork of the repository
+  - select `branches` or click on `main` and select "*View all branches*"
+  - tap `New branch`
+  - insert the name you please and select `elB4RTO/LogDoctor` as repository and `devel` as branch
 
 <br/>
 

diff --git a/README.md b/README.md
@@ -68,20 +68,21 @@ Supported web servers are **Apache2**, **Nginx** and **IIS**.
 
 <br/><br/>
 
-LogDoctor has been forked from [Craplog](https://github.com/elB4RTO/CRAPLOG).
+LogDoctor is a hard fork of [Craplog](https://github.com/elB4RTO/CRAPLOG).
 
 <br/>
 
 ## Installation and usage
 
 ### Requirements / Dependencies
 
-- **From source**:
+- **From binary**:
   - C++ 17
-  - Cmake
   - Qt5 *(Framework 5.15+, Linguist, Widgets, Charts, Sql, Network)*<br/><br/>
-- **From binary**:
-  - None
+- **From source**:
+  - *all the above*
+  - Cmake
+  - g++ / gcc / clang<br/><br/>
 
 <br/>
 
@@ -97,29 +98,57 @@ LogDoctor has been forked from [Craplog](https://github.com/elB4RTO/CRAPLOG).
 
 ### Usage with installation
 
-- **From source**
-  - Download and unzip this repo
-    <br/>*or*<br/>
-    `git clone https://github.com/elB4RTO/LogDoctor`<br/><br/>
-  - Step inside inside "*LogDoctor-main*"
-    <br/>*or*<br/>
-    `cd LogDoctor`<br/><br/>
-  - Run the installation script
-    - Linux/BSD:
-      - `chmod +x ./build_install.sh`
-      - `./build_install.sh`
-    - Windows:
-      - run `WIN_build_install_1.bat` as normal user
-      - right-click on `WIN_build_install_2.bat` and select **Run as Administrator**
-    - Mac OS:
-      - `chmod +x ./MAC_build_install.sh`
-      - `./MAC_build_install.sh`<br/><br/>
-- **From binary**
-  - Download a pre-compiled [Release](https://github.com/elB4RTO/LogDoctor/releases)
-  - Run the installation executable, or the installation script if you prefer it<br/><br/>
+#### From source
+
+- Download and unzip this repo
+  <br/>*or*<br/>
+  `git clone https://github.com/elB4RTO/LogDoctor`<br/><br/>
+- Step inside inside "*LogDoctor-main*"
+  <br/>*or*<br/>
+  `cd LogDoctor`<br/><br/>
+- Run the installation script
+  - Linux/BSD:
+    - `chmod +x ./build_install.sh`
+    - `./build_install.sh`
+  - Windows:
+    - run `WIN_build_install_1.bat` as normal user
+    - right-click on `WIN_build_install_2.bat` and select **Run as Administrator**
+  - Mac OS:
+    - `chmod +x ./MAC_build_install.sh`
+    - `./MAC_build_install.sh`
 
 <br/>
 
+#### From package
+
+##### Arch-based distributions
+
+- Pre-made package:
+  - `wget https://github.com/elB4RTO/LogDoctor/archive/refs/tags/logdoctor-<VERSION>-x86_64.pkg.tar.zst`
+  - `sudo pacman -U logdoctor-<VERSION>-x86_64.pkg.tar.zst`<br/><br/>
+- From the AUR:
+  - Using **yay**:
+    - `yay -S logdoctor`<br/>
+  - Manually:
+    - `git clone https://aur.archlinux.org/logdoctor.git`
+    - `cd logdoctor`
+    - `makepkg -sci`<br/><br/>
+
+##### Debian-based distributions
+
+- Pre-made package:
+  - `wget https://github.com/elB4RTO/LogDoctor/archive/refs/tags/logdoctor_<VERSION>_amd64.deb`
+  - `sudo apt install ./logdoctor_<VERSION>_amd64.deb`
+
+<br/>
+
+#### From binary
+
+- Download a pre-compiled [Release](https://github.com/elB4RTO/LogDoctor/releases)
+- Run the installation executable, or the installation script if you prefer it
+
+<br/><br/>
+
 ### How to compile
 
 - Install the *dependencies* you're missing (usually the list reduces to just *Qt*, and *cmake* at least).<br/><br/>
@@ -152,11 +181,11 @@ LogDoctor has been forked from [Craplog](https://github.com/elB4RTO/CRAPLOG).
     - You need to know which compiler you used, usually *MinGW*
       <br/>`cd C:\<path>\<to>\Qt\<version>\<compiler>\bin`<br/><br/>
     - Deploy Qt's libraries using Qt's additional tool:
-      <br/>`windeployqt.exe C:\<path>\<to>\<executable>\<folder>`<br/><br/>
+      <br/>`windeployqt.exe C:\<path>\<to>\<LogDoctor>`<br/><br/>
     - Deploy C++ libraries by copying them:
-      <br/>`copy "libstdc++-6.dll" C:\<path>\<to>\<executable>\<folder>`
-      <br/>`copy "libwinpthread-1.dll" C:\<path>\<to>\<executable>\<folder>`
-      <br/>`copy "libgcc_s_seh-1.dll" C:\<path>\<to>\<executable>\<folder>`<br/><br/>
+      <br/>`copy "libstdc++-6.dll" C:\<path>\<to>\<LogDoctor>`
+      <br/>`copy "libwinpthread-1.dll" C:\<path>\<to>\<LogDoctor>`
+      <br/>`copy "libgcc_s_seh-1.dll" C:\<path>\<to>\<LogDoctor>`<br/><br/>
   - You can now move the executable's folder wherever you want and execute LogDoctor from there.<br/><br/>
 
 - **Mac OS**:
@@ -175,28 +204,39 @@ To check for updates, open the menu `Utilities`→`Version check`.
 
 ### How to update
 
-At the moment of writing, the only supported method is the manual update.
-
-- **From source**
-  - Download and unzip this repo
-    <br/>*or*<br/>
-    `git clone https://github.com/elB4RTO/LogDoctor`<br/><br/>
-  - Step inside inside "*LogDoctor-main*"
-    <br/>*or*<br/>
-    `cd LogDoctor`<br/><br/>
-  - Run the update script
-    - Linux/BSD:
-      - `chmod +x ./build_update.sh`
-      - `./build_update.sh`
-    - Windows:
-      - run `WIN_build_update_1.bat` as normal user
-      - right-click on `WIN_build_update_2.bat` and select **Run as Administrator**
-    - Mac OS:
-      - `chmod +x ./MAC_build_update.sh`
-      - `./MAC_build_update.sh`<br/><br/>
-- **From binary**
-  - Download a pre-compiled [Release](https://github.com/elB4RTO/LogDoctor/releases)<br/>
-  - Run the update script
+At the moment of writing, the only supported method is the manual update.<br/><br/>
+
+#### From source
+
+- Download and unzip this repo
+  <br/>*or*<br/>
+  `git clone https://github.com/elB4RTO/LogDoctor`<br/><br/>
+- Step inside inside "*LogDoctor-main*"
+  <br/>*or*<br/>
+  `cd LogDoctor`<br/><br/>
+- Run the update script
+  - Linux/BSD:
+    - `chmod +x ./build_update.sh`
+    - `./build_update.sh`
+  - Windows:
+    - run `WIN_build_update_1.bat` as normal user
+    - right-click on `WIN_build_update_2.bat` and select **Run as Administrator**
+  - Mac OS:
+    - `chmod +x ./MAC_build_update.sh`
+    - `./MAC_build_update.sh`
+
+<br/>
+
+#### From package
+
+Follow the same process as for installing
+
+<br/>
+
+#### From binary
+
+- Download a pre-compiled [Release](https://github.com/elB4RTO/LogDoctor/releases)<br/>
+- Run the update script
 
 <br/><br/><br/>
 
@@ -428,15 +468,15 @@ A block-note utility is available at `Tools`→`BlockNote` which can be used to
 
 ### Games
 
-Simple mini-games to pass the time.
+Simple mini-games to pass the time.<br/><br/>
 
 #### CrissCross
 
-<img height="300px" src="https://raw.githubusercontent.com/elB4RTO/CRAPLOG/main/crapshots/LogDoctor/game_crisscross.png" />
+<img height="300px" src="https://raw.githubusercontent.com/elB4RTO/CRAPLOG/main/crapshots/LogDoctor/game_crisscross.png" /><br/><br/>
 
 #### Snake
 
-<img height="350px" src="https://raw.githubusercontent.com/elB4RTO/CRAPLOG/main/crapshots/LogDoctor/game_snake.png" />
+<img height="350px" src="https://raw.githubusercontent.com/elB4RTO/CRAPLOG/main/crapshots/LogDoctor/game_snake.png" /><br/><br/>
 
 <br/><br/>
 
@@ -470,13 +510,13 @@ May be higher or lower depending on the complexity of the logs, the complexity o
 
 LogDoctor is available in:
 
-- 🇬🇧 English (100%)
+- 🇬🇧 **English** (100%)
 
-- 🇮🇹 Italian (100%)
+- 🇮🇹 **Italian** (90%, *wanna [contribute](#translations)?*)
 
-- 🇪🇸 Spanish (99%, *wanna [contribute](#translations)?*)
+- 🇪🇸 **Spanish** (90%, *wanna [contribute](#translations)?*)
 
-- 🇫🇷 French (99%, *wanna [contribute](#translations)?*)
+- 🇫🇷 **French** (90%, *wanna [contribute](#translations)?*)
 
 <br/><br/>
 
@@ -496,11 +536,13 @@ If you want to contribute to the translation, please read the [Translation Guide
 
 Current translations under developement:
 
-- Spanish: **99%** *(auditor needed)*
+- Italian: **90%**
+
+- Spanish: **90%** *(auditor needed)*
 
-- French: **99%** *(auditor needed)*
+- French: **90%** *(auditor needed)*
 
-If you have a request for a missing language please refer to [this issue](https://github.com/elB4RTO/LogDoctor/issues/10).
+If you have a request for a missing language or you're willing to contribute, please refer to [this issue](https://github.com/elB4RTO/LogDoctor/issues/10).
 
 <br/>