diff --git a/HOW_TO_INSTALL.md b/HOW_TO_INSTALL.md new file mode 100644 index 00000000..f0024daf --- /dev/null +++ b/HOW_TO_INSTALL.md @@ -0,0 +1,61 @@ +# How to install + +
+ +## From source + +- Run the installation script + - Linux: + - `bash scripts/LINUX_build_install.sh` + - BSD: + - `bash scripts/BSD_build_install.sh` + - Windows: + - step inside the *scripts* folder + - 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 + +- Run the installation script + - Linux: + - `bash scripts/DOCKER_build_install.sh` + +