mirror of
https://github.com/Bionus/imgbrd-grabber.git
synced 2025-01-09 04:09:51 +08:00
docs: expand on the various install methods
This commit is contained in:
Bionus
parent
5880efdd6d
commit
ef93b332f2
11
README.md
11
README.md
@ -25,13 +25,10 @@ You can download the latest release [here](https://github.com/Bionus/imgbrd-grab
|
||||
|
||||
For users interested, a nightly version is built automatically on every commit on the `develop` branch, and can be downloaded [here](https://github.com/Bionus/imgbrd-grabber/releases/nightly). Note that it might be less stable than official releases, so use at your own risk.
|
||||
|
||||
### Installation on Arch Linux
|
||||
For Arch Linux users, there are packages on the AUR
|
||||
* [imgbrd-grabber-bin](https://aur.archlinux.org/packages/imgbrd-grabber-bin) which pulls the latest `tar.gz` release.
|
||||
* [imgbrd-grabber-appimage](https://aur.archlinux.org/packages/imgbrd-grabber-appimage) which pulls the latest `appimage` release.
|
||||
* [imgbrd-grabber](https://aur.archlinux.org/packages/imgbrd-grabber) which builds the package from source.
|
||||
|
||||
Install by issuing the command, substituting the package you want to install: `paru -Sy imgbrd-grabber-bin`
|
||||
* [Install steps for Windows](https://www.bionus.org/imgbrd-grabber/docs/install/windows.html)
|
||||
* [Install steps for Linux](https://www.bionus.org/imgbrd-grabber/docs/install/linux.html)
|
||||
* [Install steps for MacOS](https://www.bionus.org/imgbrd-grabber/docs/install/macos.html)
|
||||
* [Install steps for Android](https://www.bionus.org/imgbrd-grabber/docs/install/android.html)
|
||||
|
||||
## Features
|
||||
|
||||
|
||||
@ -1,3 +1,9 @@
|
||||
- name: Installation
|
||||
children:
|
||||
- link: /docs/install/windows.html
|
||||
- link: /docs/install/linux.html
|
||||
- link: /docs/install/macos.html
|
||||
- link: /docs/install/android.html
|
||||
- name: Basics
|
||||
children:
|
||||
- link: /docs/
|
||||
|
||||
@ -6,25 +6,10 @@ permalink: /docs/
|
||||
|
||||
# Installation
|
||||
|
||||
## Windows
|
||||
|
||||
1. Download the latest Windows installer [here](https://github.com/Bionus/imgbrd-grabber/releases/latest).
|
||||
2. Launch the installer, then follow the instructions. By default, the program will be installed to "C:/Program Files/Grabber" (note that all your settings will be stored in "%USERPROFILE%/AppData/Local/Bionus/Grabber").
|
||||
3. If you haven't left the "start Grabber" checked at the end of the installation, go to the installation folder, then launch "Grabber.exe" (or use the shortcut created on the desktop during the installation).
|
||||
|
||||
## Arch Linux
|
||||
For Arch Linux users, there are packages on the AUR
|
||||
* [imgbrd-grabber-bin](https://aur.archlinux.org/packages/imgbrd-grabber-bin) which pulls the latest `tar.gz` release.
|
||||
* [imgbrd-grabber-appimage](https://aur.archlinux.org/packages/imgbrd-grabber-appimage) which pulls the latest `appimage` release.
|
||||
* [imgbrd-grabber](https://aur.archlinux.org/packages/imgbrd-grabber) which builds the package from source.
|
||||
|
||||
Install by issuing the command, substituting the package you want to install: `paru -Sy imgbrd-grabber-bin`
|
||||
|
||||
## Linux
|
||||
Compile Grabber by following the instructions on the [Compilation]({{ site.baseurl }}{% link _docs/compilation.md %}#linux) page. Upon completion run `make install`.
|
||||
|
||||
### Linux Configuration
|
||||
After installation you will need to copy the example configuration files from `$INSTALLATIONPREFIX/Grabber/example/` to your local Grabber directory, usually `~/.Grabber/`. Grabber will not run without these files.
|
||||
* [Install steps for Windows]({{ site.baseurl }}{% link _docs/install/windows.md %})
|
||||
* [Install steps for Linux]({{ site.baseurl }}{% link _docs/install/linux.md %})
|
||||
* [Install steps for MacOS]({{ site.baseurl }}{% link _docs/install/macos.md %})
|
||||
* [Install steps for Android]({{ site.baseurl }}{% link _docs/install/android.md %})
|
||||
|
||||
# Usage
|
||||
|
||||
|
||||
12
docs/_docs/install/android.md
Normal file
12
docs/_docs/install/android.md
Normal file
@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Android
|
||||
---
|
||||
|
||||
|
||||
# Installing Grabber on Android
|
||||
|
||||
## Via the APK
|
||||
1. Go to the latest release [here](https://github.com/Bionus/imgbrd-grabber/releases/latest)
|
||||
2. Download the `.apk` file
|
||||
3. Install it
|
||||
4. Run the application called `Grabber`
|
||||
40
docs/_docs/install/linux.md
Normal file
40
docs/_docs/install/linux.md
Normal file
@ -0,0 +1,40 @@
|
||||
---
|
||||
title: Linux
|
||||
---
|
||||
|
||||
|
||||
# Installing Grabber on Linux
|
||||
|
||||
## Via the AppImage
|
||||
1. Go to the latest release [here](https://github.com/Bionus/imgbrd-grabber/releases/latest)
|
||||
2. Download the `.AppImage` file
|
||||
3. Make it executable using the command:
|
||||
```
|
||||
chmod +x Grabber_*-x86_64.AppImage
|
||||
```
|
||||
4. Double click on the AppImage file to start Grabber
|
||||
|
||||
## Via the pre-built binary archive
|
||||
1. Go to the latest release [here](https://github.com/Bionus/imgbrd-grabber/releases/latest)
|
||||
2. Download the `.tar.gz` file
|
||||
3. Extract it anywhere using the command:
|
||||
```
|
||||
tar -xzf Grabber_*.tar.gz
|
||||
```
|
||||
4. Launch the `Grabber` executable to start Grabber
|
||||
|
||||
ℹ️ Grabber requires Qt5 libraries to run. If you see a "error while loading shared libraries" error, make sure you have the Qt5 packages installed. On Ubuntu, they can be installed with:
|
||||
```
|
||||
sudo apt install libqt5gui5 libqt5qml5 libqt5xml5 libqt5networkauth5 libqt5sql5 libqt5multimedia5 libqt5multimediawidgets5
|
||||
```
|
||||
|
||||
## Via the AUR (Arch Linux)
|
||||
Grabber has packages on the AUR for Arch Linux:
|
||||
* [imgbrd-grabber-bin](https://aur.archlinux.org/packages/imgbrd-grabber-bin) which pulls the latest `tar.gz` release.
|
||||
* [imgbrd-grabber-appimage](https://aur.archlinux.org/packages/imgbrd-grabber-appimage) which pulls the latest `appimage` release.
|
||||
* [imgbrd-grabber](https://aur.archlinux.org/packages/imgbrd-grabber) which builds the package from source.
|
||||
|
||||
You can install Grabber by running this command, substituting the package you want to install:
|
||||
```
|
||||
paru -Sy imgbrd-grabber-bin
|
||||
```
|
||||
27
docs/_docs/install/macos.md
Normal file
27
docs/_docs/install/macos.md
Normal file
@ -0,0 +1,27 @@
|
||||
---
|
||||
title: MacOS
|
||||
---
|
||||
|
||||
|
||||
# Installing Grabber on MacOS
|
||||
|
||||
## Via Homebrew
|
||||
1. Install [Homebrew](https://brew.sh/)
|
||||
2. Add the Grabber tap using the command:
|
||||
```
|
||||
brew tap Bionus/imgbrd-grabber
|
||||
```
|
||||
3. Install the Grabber cask using the command:
|
||||
```
|
||||
brew install imgbrd-grabber
|
||||
```
|
||||
|
||||
## Via the DMG
|
||||
1. Go to the latest release [here](https://github.com/Bionus/imgbrd-grabber/releases/latest)
|
||||
2. Download the `.dmg` file
|
||||
3. Open the `.dmg` file
|
||||
4. Drag and drop the `Grabber.app` file to your `Applications` directory
|
||||
5. Eject and remove the `.dmg` file
|
||||
5. Launch Grabber via Launchpad
|
||||
|
||||
⚠️ Grabber is not a verified Apple application, so you might get a "the developer cannot be verified" error. In that case, you should open Finder, go to your `Applications` directory, then right click `Grabber.app` then choose "Open". Then, you'll be able to choose "Open" to start Grabber anyway. You only need to do this once. More information [here](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac).
|
||||
20
docs/_docs/install/windows.md
Normal file
20
docs/_docs/install/windows.md
Normal file
@ -0,0 +1,20 @@
|
||||
---
|
||||
title: Windows
|
||||
---
|
||||
|
||||
|
||||
# Installing Grabber on Windows
|
||||
|
||||
## Via the installer
|
||||
1. Go to the latest release [here](https://github.com/Bionus/imgbrd-grabber/releases/latest)
|
||||
2. Download the `.exe` file corresponding to your CPU architecture,`x64` for 64-bit, `x86` for 32-bit (if you're not sure, you likely have a 64-bit CPU)
|
||||
3. Launch the installer and follow the steps
|
||||
4. If you haven't left the "start Grabber" checked at the end of the installation, go to the installation folder then launch `Grabber.exe` (or use the shortcut created on the desktop during the installation).
|
||||
|
||||
ℹ️ By default, the program will be installed to `C:/Program Files/Grabber` and your settings will be stored in `%LocalAppData%/Bionus/Grabber`
|
||||
|
||||
## Via the portable version
|
||||
1. Go to the latest release [here](https://github.com/Bionus/imgbrd-grabber/releases/latest)
|
||||
2. Download the `.zip` file corresponding to your CPU architecture,`x64` for 64-bit, `x86` for 32-bit (if you're not sure, you likely have a 64-bit CPU)
|
||||
3. Extract the archive anywhere on your computer
|
||||
4. Launch `Grabber.exe`
|
||||
Loading…
Reference in New Issue
Block a user