From 212f2cacf49d6cb015bad5c5b25e07fef4cc88b6 Mon Sep 17 00:00:00 2001 From: Valentino Orlandi Date: Sun, 8 Oct 2023 21:14:56 +0000 Subject: [PATCH] Updated README.md --- README.md | 230 +++--------------------------------------------------- 1 file changed, 13 insertions(+), 217 deletions(-) diff --git a/README.md b/README.md index 95857e53..feeec832 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,8 @@ LogDoctor is a hard fork of [Craplog](https://git.disroot.org/elB4RTO/CRAPLOG). - *all the above* - Cmake - gcc / clang / msvc

+- **As Docker**: + - Docker


@@ -95,7 +97,7 @@ LogDoctor is a hard fork of [Craplog](https://git.disroot.org/elB4RTO/CRAPLOG). - Download a pre-compiled [Release](https://git.disroot.org/elB4RTO/LogDoctor/releases)
*or*
- Follow the step-by-step "[How to compile](#how-to-compile)" guide + Follow the step-by-step guide in [HOW_TO_COMPILE.md](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/HOW_TO_COMPILE.md) - Run the executable @@ -103,108 +105,13 @@ LogDoctor is a hard fork of [Craplog](https://git.disroot.org/elB4RTO/CRAPLOG). ### Usage with installation -#### From source - -- Download and unzip this repo -
*or*
- `git clone https://git.disroot.org/elB4RTO/LogDoctor -b main --depth 1`

-- Step inside inside "*LogDoctor-main*" -
*or*
- `cd LogDoctor`

-- Run the installation script - - Linux: - - `bash scripts/LINUX_build_install.sh` - - BSD: - - `bash scripts/BSD_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: - - `bash scripts/MAC_build_install.sh`

- -#### From package - -**Arch-based distributions** - -- Pre-made package: - - Step in the [Release](https://git.disroot.org/elB4RTO/LogDoctor/releases) page - - Download `logdoctor--x86_64.pkg.tar.zst` - - Run `sudo pacman -U logdoctor--x86_64.pkg.tar.zst`

-- From the AUR: - - Using **yay**: - - `yay -S logdoctor`
- - Manually: - - `git clone https://aur.archlinux.org/logdoctor.git -b master --depth 1` - - `cd logdoctor` - - `makepkg -sci`

- -**Debian-based distributions** - -- Pre-made package: - - Step in the [Release](https://git.disroot.org/elB4RTO/LogDoctor/releases) page - - Download `logdoctor__amd64.deb` - - Run `sudo apt install ./logdoctor__amd64.deb`

- -#### From binary - -- Download a pre-compiled [Release](https://git.disroot.org/elB4RTO/LogDoctor/releases) -- Run the installation executable, or the installation script if you prefer it

- -#### As Docker image - -- Download and unzip this repo -
*or*
- `git clone https://git.disroot.org/elB4RTO/LogDoctor -b main --depth 1`

-- Step inside inside "*LogDoctor-main*" -
*or*
- `cd LogDoctor`

-- Run the installation script - - Linux: - - `bash scripts/DOCKER_build_install.sh` +See [HOW_TO_INSTALL.md](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/HOW_TO_INSTALL.md)
### How to compile -- Install the *dependencies* you're missing.

-- Download and unzip this repo -
*or*
- `git clone https://git.disroot.org/elB4RTO/LogDoctor -b main --depth 1`

-- Open a terminal inside "*LogDoctor-main/*" -
*or*
- `cd LogDoctor/`

-- Prepare a build folder: -
`mkdir build && cd build`

-- Prepare **Cmake**'s build files: -
`cmake ../logdoctor -DCMAKE_BUILD_TYPE=MinSizeRel`

-- Use **Cmake** to compile the entire project: -
`cmake --build ./ --target all`

- If compilation fails, use the following command before to rebuild: -
`cmake --build ./ --target clean` -

- -#### Additional steps - -- **Linux** / **BSD**: - - No additional steps. Once compiling is done, you can move the executable file wherever you want and execute it from there.

- -- **Windows**: - - Create a new folder and move the executable in it: -
`mkdir LogDoctor && move LogDoctor.exe .\LogDoctor`

- - Add the needed libraries to the executable's folder:
- - You need to know the path of your Qt installation, default is *C:\Qt*
- - You need to know which compiler you used, usually *MinGW* -
`cd C:\\\Qt\\\bin`

- - Deploy Qt's libraries using Qt's additional tool: -
`windeployqt.exe C:\\\`

- - Deploy C++ libraries by copying them: -
`copy "libstdc++-6.dll" C:\\\` -
`copy "libwinpthread-1.dll" C:\\\` -
`copy "libgcc_s_seh-1.dll" C:\\\`

- - You can now move the executable's folder wherever you want and execute LogDoctor from there.

- -- **Mac OS**: - - No additional steps. Once compiling is done, you can use the app bundle to execute LogDoctor. +See [HOW_TO_COMPILE.md](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/HOW_TO_COMPILE.md)

@@ -213,53 +120,11 @@ LogDoctor is a hard fork of [Craplog](https://git.disroot.org/elB4RTO/CRAPLOG). ### Version check A version check utility is available while running LogDoctor to check the availability of a new version.
-To check for updates, open the menu `Utilities`→`Version check`. - -
+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 -
*or*
- `git clone https://bitbucket.org/elB4RTO/LogDoctor -b main --depth 1`

-- Step inside inside "*LogDoctor-main*" -
*or*
- `cd LogDoctor`

-- Run the update script - - Linux: - - `bash LINUX_build_update.sh` - - BSD: - - `bash BSD_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: - - `bash MAC_build_update.sh`

- -#### From package - -Follow the same process as for installing - -#### From binary - -- Download a pre-compiled [Release](https://git.disroot.org/elB4RTO/LogDoctor/releases)
-- Run the update script - -#### As Docker image - -- Download and unzip this repo -
*or*
- `git clone https://git.disroot.org/elB4RTO/LogDoctor -b main --depth 1`

-- Step inside inside "*LogDoctor-main*" -
*or*
- `cd LogDoctor`

-- Run the update script - - Linux: - - `bash scripts/DOCKER_build_update.sh` +See [HOW_TO_UPDATE.md](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/HOW_TO_UPDATE.md)


@@ -491,7 +356,7 @@ 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 kill the time

#### CrissCross @@ -537,13 +402,13 @@ LogDoctor is available in: - 🇮🇹 **Italian** (100%) -- 🇪🇸 **Spanish** (90%, *wanna [contribute](#translations)?*) +- 🇪🇸 **Spanish** (90%, *wanna [contribute](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/TRANSLATING.md)?*) -- 🇫🇷 **French** (90%, *wanna [contribute](#translations)?*) +- 🇫🇷 **French** (90%, *wanna [contribute](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/TRANSLATING.md)?*) -- 🇧🇷 **Portuguese** [**Brazil**] (90%, *wanna [contribute](#translations)?*) +- 🇧🇷 **Portuguese** [**Brazil**] (90%, *wanna [contribute](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/TRANSLATING.md)?*) -- 🇯🇵 **Japanese** (90%, *wanna [contribute](#translations)?*) +- 🇯🇵 **Japanese** (90%, *wanna [contribute](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/TRANSLATING.md)?*)

@@ -555,75 +420,6 @@ If you have suggestions about how to improve it, please open an [issue](https:// If you want to contribute to the code, please read the [Contribution Guidelines](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/CONTRIBUTING.md). -If you want to contribute to the translation, please read the [Translation Guidelines](#translation-guidelines). - -
- -### Translations - -Current translations under developement: - -- `es_ES` : **90%** *(auditor needed)* - -- `fr_FR` : **90%** *(auditor needed)* - -- `pt_BR` : **90%** *(auditor needed)* - -- `ja_JP` : **90%** *(auditor needed)* - -If you have a request for a missing language or you're willing to contribute, please refer to [this issue](https://git.disroot.org/elB4RTO/LogDoctor/issues/10). - -
- -#### How to contribute to translations - -Since the whole application is build upon Qt, translations are made throught `.ts` [translation files](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/logdoctor/translations). - -
- -The easiest way to go is to use **Qt Linguist**: -- Download or clone this repo
-- Open the `.ts` translation file of your language using QtLinguist
-- Translate (*don't know how? Follow [this video](https://www.youtube.com/watch?v=GNyfkuDchNQ)*)
-- **Push only the `.ts` files, you don't have to release them**: pull request containing `.qm` binaries won't be accepted.
- -

- -If you don't want to install QtLinguist, you can do it the hard way, by opening the files with a text editor and do it manually: -- Here is a sample of some text waiting for translation
- You can see the original text enclosed in the `` tags. Don't edit it.
- ``` - - - This is the original text - - ``` -- Everything you need to do is to add the missing line containing the translated text, without editing the other lines.
- Here is a sample after having translated it
- ``` - - - Original text - Translated text goes here - - ``` - -
- -If you don't feel comfortable with any of the above solutions, please open an [issue](https://git.disroot.org/elB4RTO/LogDoctor/issues) and write your translations/corrections there, in a clear way. - -
- -#### Translation guidelines - -*[hints from Qt](https://doc.qt.io/qt-6/linguist-overview.html)* - -Just follow some simple guidelines to ensure a correct and clear contribution: - -- Respect the structure of the phrase: if *(for example)* it starts or ends with a whitespace or something, please do the same. - -- Please leave your translations marked as *unfinished*, they will be checked and un-marked after having been verified. - -- If you see a translation marked as *finished*, please edit it only if you're sure that your definition suits better. +If you want to contribute to the translation, please read the [Translation Guidelines](https://git.disroot.org/elB4RTO/LogDoctor/src/branch/main/TRANSLATING.md).