Skip to content

Commit

Permalink
docs: fix various typos and grammar issues
Browse files Browse the repository at this point in the history
  • Loading branch information
Bionus committed Nov 16, 2023
1 parent b6e7302 commit 88b3ca2
Show file tree
Hide file tree
Showing 38 changed files with 230 additions and 230 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ After you've determined that your idea have not already been suggested, create a

## Reporting Bugs

Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports, which in turn helps fixing the issue you faced.
Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports, which in turn helps to fix the issue you faced.

Start by [a search](https://github.com/Bionus/imgbrd-grabber/issues?q=is%3Aissue) to see if the problem has already been reported. If so, you add information to it if you feel it could help.

Expand All @@ -53,14 +53,14 @@ Include details about your configuration and environment:
* **Which version of Grabber are you using?** You can get the exact version by going in the `About` menu and clicking `About Grabber`.
* **What's the name and version of the OS you're using**?
* **Are you running Grabber in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
* **Provide your `main.log` file** to see if any obvious error occured.
* **Provide your `main.log` file** to see if any obvious error occurred.
* **Provide your `settings.ini` file** will greatly help maintainers reproduce your problem if it may be caused by your configuration.

Note that both `main.log` and `settings.ini` files can be found in `C:/Users/%USERNAME%/AppData/Local/Bionus/Grabber` in Windows, and in the installation directory on Linux.

## Reporting crashes

Start by follwing the [Reporting Bugs](#reporting-bugs) guidelines. Additionally, a few more information will be required:
Start by following the [Reporting Bugs](#reporting-bugs) guidelines. Additionally, a few more information will be required:

* **Provide the crash dump** that was linked by the Crash Reporter tool.
* **If the crash occured during a download, make sure to provide said download**. You can simply provide the `.igl` file that Grabber can generate by clicking the `Save` button of the `Downloads` tab.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ For users interested, a nightly version is built automatically on every commit o

* [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 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
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/posts/2020-10-29-android-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For those that might not follow the project closely on GitHub, there's a new And

![Screenshot](../../assets/img/blog/android-version.png)

You can find more details here, such as screenshots, status, roadmap, etc:
You can find more details here, such as screenshots, status, roadmap, etc.:
[Bionus/imgbrd-grabber#2147](https://github.com/Bionus/imgbrd-grabber/issues/2147)

Or if you just want to download it, here's the link!
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Hey everyone!

Some might have already noticed, but the Grabber build is slowly being migrated to [GitHub actions](https://github.com/features/actions).

Until now, it was using [AppVeyor](https://www.appveyor.com/) for Windows builds and [Travis CI](https://travis-ci.org/) for Linux and MacOS builds.
Until now, it was using [AppVeyor](https://www.appveyor.com/) for Windows builds and [Travis CI](https://travis-ci.org/) for Linux and macOS builds.

<!-- more -->

Expand Down
4 changes: 2 additions & 2 deletions docs/blog/posts/2021-01-21-tag-databases.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Hey everyone!
&nbsp;

Tag databases, while documented [on this very website](https://www.bionus.org/imgbrd-grabber/docs/tools/tag-loader.html), is a little-known feature of Grabber.
However, they are very useful, and as such there is ongoing work to make them more easy to use.
However, they are very useful, and as such there is ongoing work to make them easier to use.

<!-- more -->

Part of this work is a way to provide already generated tag databases so that users don't need to spend a lot of time and overload servers' tag APIs. The more people use tag databases, the less requests are done on servers, saving both users and servers bandwidth, since the additional request to get tag information is not necessary anymore.
Part of this work is a way to provide already generated tag databases so that users don't need to spend a lot of time and overload servers' tag APIs. The more people use tag databases, the fewer requests are done on servers, saving both users and servers bandwidth, since the additional request to get tag information is not necessary anymore.

The already generated tag databases can now be found here:
<https://github.com/Bionus/imgbrd-grabber/releases/tag-databases>
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/posts/2023-08-18-new-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For those that did not have the chance to see the previous look, here is a befor
![Before](../../assets/img/blog/old-homepage.png){ width="49%" }
![After](../../assets/img/blog/new-homepage.png){ width="49%" }

Thanks again to everyone using and supporting Grabber everyday!
Thanks again to everyone using and supporting Grabber every day!

&nbsp;

Expand Down
96 changes: 48 additions & 48 deletions docs/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You can set a source using the "-s" or "--sources" parameter, followed by the li

### Count the number of images
Prints the result followed by a new line to stdout.
```
```bash
./grabber -c -t "inugami_kira" -s "danbooru.donmai.us" --return-count
288

Expand Down Expand Up @@ -71,43 +71,43 @@ thighhighs 613879 general
Prints each result separated by a new line.
```
./grabber -c -t "inugami_kira" -s "danbooru.donmai.us" -i 5 -p 3 --return-images
http://danbooru.donmai.us/data/10d3ae95f0f5b7ea65cd3f07e541cfdf.jpg
http://danbooru.donmai.us/data/3612d866e07f13d632132c99f704fc57.jpg
http://danbooru.donmai.us/data/8766a8dad81082c631fbcb25328029e4.jpg
http://danbooru.donmai.us/data/a820e3967048b0d7c7a197de748d7505.jpg
http://danbooru.donmai.us/data/85ba43a3470236f16807d102ebb9befe.jpg
https://cdn.donmai.us/original/10/d3/10d3ae95f0f5b7ea65cd3f07e541cfdf.png
https://cdn.donmai.us/original/36/12/3612d866e07f13d632132c99f704fc57.png
https://cdn.donmai.us/original/87/66/8766a8dad81082c631fbcb25328029e4.png
https://cdn.donmai.us/original/a8/20/a820e3967048b0d7c7a197de748d7505.png
https://cdn.donmai.us/original/85/ba/85ba43a3470236f16807d102ebb9befe.png
./grabber -c -t "inugami_kira" -s "gelbooru.com" -i 5 -p 3 --return-images
http://simg2.gelbooru.com/images/2080/8766a8dad81082c631fbcb25328029e4.png
http://simg2.gelbooru.com/images/2080/3612d866e07f13d632132c99f704fc57.png
http://simg2.gelbooru.com/images/2080/10d3ae95f0f5b7ea65cd3f07e541cfdf.png
http://simg2.gelbooru.com/images/2080/7a3fa58e9e669c2fdc2fb6596e13ed40.png
http://simg2.gelbooru.com/images/2077/eea3d1e72f2f33521ccf68874b408d38.png
https://img3.gelbooru.com/images/87/66/8766a8dad81082c631fbcb25328029e4.png
https://img3.gelbooru.com/images/36/12/3612d866e07f13d632132c99f704fc57.png
https://img3.gelbooru.com/images/10/d3/10d3ae95f0f5b7ea65cd3f07e541cfdf.png
https://img3.gelbooru.com/images/7a/3f/7a3fa58e9e669c2fdc2fb6596e13ed40.png
https://img3.gelbooru.com/images/ee/a3/eea3d1e72f2f33521ccf68874b408d38.png
./grabber -c -t "inugami_kira" -s "danbooru.donmai.us gelbooru.com" -i 5 -p 3 --return-images
http://danbooru.donmai.us/data/10d3ae95f0f5b7ea65cd3f07e541cfdf.jpg
http://danbooru.donmai.us/data/3612d866e07f13d632132c99f704fc57.jpg
http://danbooru.donmai.us/data/8766a8dad81082c631fbcb25328029e4.jpg
http://danbooru.donmai.us/data/a820e3967048b0d7c7a197de748d7505.jpg
http://danbooru.donmai.us/data/85ba43a3470236f16807d102ebb9befe.jpg
http://simg2.gelbooru.com/images/2080/8766a8dad81082c631fbcb25328029e4.png
http://simg2.gelbooru.com/images/2080/3612d866e07f13d632132c99f704fc57.png
http://simg2.gelbooru.com/images/2080/10d3ae95f0f5b7ea65cd3f07e541cfdf.png
http://simg2.gelbooru.com/images/2080/7a3fa58e9e669c2fdc2fb6596e13ed40.png
http://simg2.gelbooru.com/images/2077/eea3d1e72f2f33521ccf68874b408d38.png
https://cdn.donmai.us/original/10/d3/10d3ae95f0f5b7ea65cd3f07e541cfdf.png
https://cdn.donmai.us/original/36/12/3612d866e07f13d632132c99f704fc57.png
https://cdn.donmai.us/original/87/66/8766a8dad81082c631fbcb25328029e4.png
https://cdn.donmai.us/original/a8/20/a820e3967048b0d7c7a197de748d7505.png
https://cdn.donmai.us/original/85/ba/85ba43a3470236f16807d102ebb9befe.png
https://img3.gelbooru.com/images/87/66/8766a8dad81082c631fbcb25328029e4.png
https://img3.gelbooru.com/images/36/12/3612d866e07f13d632132c99f704fc57.png
https://img3.gelbooru.com/images/10/d3/10d3ae95f0f5b7ea65cd3f07e541cfdf.png
https://img3.gelbooru.com/images/7a/3f/7a3fa58e9e669c2fdc2fb6596e13ed40.png
https://img3.gelbooru.com/images/ee/a3/eea3d1e72f2f33521ccf68874b408d38.png
```

#### Duplicates
You can use the "-n" or "--no-duplicates" option to remove duplicate results when downloading from several sources based on MD5.
```
./grabber -c -t "inugami_kira" -s "danbooru.donmai.us gelbooru.com" -i 5 -p 3 --return-images --no-duplicates
http://danbooru.donmai.us/data/10d3ae95f0f5b7ea65cd3f07e541cfdf.jpg
http://danbooru.donmai.us/data/3612d866e07f13d632132c99f704fc57.jpg
http://danbooru.donmai.us/data/8766a8dad81082c631fbcb25328029e4.jpg
http://danbooru.donmai.us/data/a820e3967048b0d7c7a197de748d7505.jpg
http://danbooru.donmai.us/data/85ba43a3470236f16807d102ebb9befe.jpg
http://simg2.gelbooru.com/images/2080/7a3fa58e9e669c2fdc2fb6596e13ed40.png
http://simg2.gelbooru.com/images/2077/eea3d1e72f2f33521ccf68874b408d38.png
https://cdn.donmai.us/original/10/d3/10d3ae95f0f5b7ea65cd3f07e541cfdf.png
https://cdn.donmai.us/original/36/12/3612d866e07f13d632132c99f704fc57.png
https://cdn.donmai.us/original/87/66/8766a8dad81082c631fbcb25328029e4.png
https://cdn.donmai.us/original/a8/20/a820e3967048b0d7c7a197de748d7505.png
https://cdn.donmai.us/original/85/ba/85ba43a3470236f16807d102ebb9befe.png
https://img3.gelbooru.com/images/7a/3f/7a3fa58e9e669c2fdc2fb6596e13ed40.png
https://img3.gelbooru.com/images/ee/a3/eea3d1e72f2f33521ccf68874b408d38.png
```

#### Images per page
Expand All @@ -118,28 +118,28 @@ You can use the "-m" or "--max" option to choose how many images you want to ret
Mixed together, they can allow to get multiple pages for a single request. For example, "-i 2 -m 10" will return the same result as "-i 10", but will use 5 requests to do so.
```
./grabber -c -t "inugami_kira" -s "danbooru.donmai.us" -i 10 --return-images
http://danbooru.donmai.us/data/3fccf5d7c6a0fe066cb0c6d3d584dba4.jpg
http://danbooru.donmai.us/data/92bde7d2b5b5b045e3d03e2544499f4b.jpg
http://danbooru.donmai.us/data/27de992712f6bae5c03357cf4e63ea0a.jpg
http://danbooru.donmai.us/data/3412be9340651fe39c09bc1405d4b9c2.jpg
http://danbooru.donmai.us/data/861e7414086026f3f1d3dfe11dfe9237.jpg
http://danbooru.donmai.us/data/eb35c0dee3e05ffeda18eba4917c33ff.jpg
http://danbooru.donmai.us/data/092d892110825a6cbdf1bde24241c030.jpg
http://danbooru.donmai.us/data/dacde25c81be108389854c32f1bdeb3d.jpg
http://danbooru.donmai.us/data/100cd43adb60f390309d14c1ce8bb853.jpg
http://danbooru.donmai.us/data/7a3fa58e9e669c2fdc2fb6596e13ed40.jpg
https://cdn.donmai.us/original/3f/cc/3fccf5d7c6a0fe066cb0c6d3d584dba4.png
https://cdn.donmai.us/original/92/bd/92bde7d2b5b5b045e3d03e2544499f4b.png
https://cdn.donmai.us/original/27/de/27de992712f6bae5c03357cf4e63ea0a.png
https://cdn.donmai.us/original/34/12/3412be9340651fe39c09bc1405d4b9c2.png
https://cdn.donmai.us/original/86/1e/861e7414086026f3f1d3dfe11dfe9237.png
https://cdn.donmai.us/original/eb/35/eb35c0dee3e05ffeda18eba4917c33ff.png
https://cdn.donmai.us/original/09/2d/092d892110825a6cbdf1bde24241c030.png
https://cdn.donmai.us/original/da/cd/dacde25c81be108389854c32f1bdeb3d.png
https://cdn.donmai.us/original/10/0c/100cd43adb60f390309d14c1ce8bb853.png
https://cdn.donmai.us/original/7a/3f/7a3fa58e9e669c2fdc2fb6596e13ed40.png
./grabber -c -t "inugami_kira" -s "danbooru.donmai.us" -i 2 -m 10 --return-images
http://danbooru.donmai.us/data/3fccf5d7c6a0fe066cb0c6d3d584dba4.jpg
http://danbooru.donmai.us/data/92bde7d2b5b5b045e3d03e2544499f4b.jpg
http://danbooru.donmai.us/data/27de992712f6bae5c03357cf4e63ea0a.jpg
http://danbooru.donmai.us/data/3412be9340651fe39c09bc1405d4b9c2.jpg
http://danbooru.donmai.us/data/861e7414086026f3f1d3dfe11dfe9237.jpg
http://danbooru.donmai.us/data/eb35c0dee3e05ffeda18eba4917c33ff.jpg
http://danbooru.donmai.us/data/092d892110825a6cbdf1bde24241c030.jpg
http://danbooru.donmai.us/data/dacde25c81be108389854c32f1bdeb3d.jpg
http://danbooru.donmai.us/data/100cd43adb60f390309d14c1ce8bb853.jpg
http://danbooru.donmai.us/data/7a3fa58e9e669c2fdc2fb6596e13ed40.jpg
https://cdn.donmai.us/original/3f/cc/3fccf5d7c6a0fe066cb0c6d3d584dba4.png
https://cdn.donmai.us/original/92/bd/92bde7d2b5b5b045e3d03e2544499f4b.png
https://cdn.donmai.us/original/27/de/27de992712f6bae5c03357cf4e63ea0a.png
https://cdn.donmai.us/original/34/12/3412be9340651fe39c09bc1405d4b9c2.png
https://cdn.donmai.us/original/86/1e/861e7414086026f3f1d3dfe11dfe9237.png
https://cdn.donmai.us/original/eb/35/eb35c0dee3e05ffeda18eba4917c33ff.png
https://cdn.donmai.us/original/09/2d/092d892110825a6cbdf1bde24241c030.png
https://cdn.donmai.us/original/da/cd/dacde25c81be108389854c32f1bdeb3d.png
https://cdn.donmai.us/original/10/0c/100cd43adb60f390309d14c1ce8bb853.png
https://cdn.donmai.us/original/7a/3f/7a3fa58e9e669c2fdc2fb6596e13ed40.png
```

### Get tags list
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/commands/danbooru.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ It pretty much only amounts to downloading the `docker-compose.yaml` file and do

### Install NodeJS

You need NodeJS to be installed on your machine to use the upload script used by Grabber.
You need Node.js to be installed on your machine to use the upload script used by Grabber.
You can download it from [their website](https://nodejs.org/en/download/), or from a package manager [here](https://nodejs.org/en/download/package-manager/).


Expand All @@ -43,7 +43,7 @@ Download the [danbooru.js](danbooru.js) file into Grabber's installation folder.

### Install NodeJS global packages

This script uses the NodeJS [axios](https://www.npmjs.com/package/axios) and [form-data](https://www.npmjs.com/package/form-data) packages, so you can install them with:
This script uses the Node.js [axios](https://www.npmjs.com/package/axios) and [form-data](https://www.npmjs.com/package/form-data) packages, so you can install them with:
```bash
npm install -g axios form-data
```
Expand Down Expand Up @@ -72,7 +72,7 @@ Make sure to replace `YOUR_USERNAME` by your Danbooru username, and `YOUR_API_KE

If you want to open newly added images in your browser, you need to edit the `danbooru.js` file, and change `OPEN_BROWSER` from `false` to `true`.

You'll also need to install the NodeJS [open](https://www.npmjs.com/package/open) package, that you can install with:
You'll also need to install the Node.js [open](https://www.npmjs.com/package/open) package, that you can install with:
```bash
npm install -g open
```
Loading

0 comments on commit 88b3ca2

Please sign in to comment.