Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updating documentation, removing stray $ character #54

Merged
merged 1 commit into from
Jan 8, 2025
Merged

docs: updating documentation, removing stray $ character #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/01_Getting_Started/02_Quick_Start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Via Composer

```sh
$ composer require tigitz/php-spellchecker
composer require tigitz/php-spellchecker
```

# Usage
Expand Down
20 changes: 10 additions & 10 deletions docs/content/03_Spellcheckers/01_Aspell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@ GNU Aspell is available in the default repositories of most Linux distributions,
On **Arch Linux** and derivatives like **Antergos**, **Manjaro Linux**, run:

```sh
$ sudo pacman -S aspell
sudo pacman -S aspell
```
On **Fedora**:
```sh
$ sudo dnf install aspell
sudo dnf install aspell
```
On **RHEL**, **CentOS**:
```sh
$ sudo yum install epel-release
sudo yum install epel-release

$ sudo yum install aspell
sudo yum install aspell
```
On **Debian**, **Ubuntu**:
```sh
$ sudo apt-get install aspell
sudo apt-get install aspell
```

on **Mac OSX** with **Homebrew**:
Expand All @@ -34,24 +34,24 @@ By default, Aspell won’t have any dictionaries. To add a dictionary, for examp

This can also be found in the default repositories. For instance, to add English dictionary on Arch linux, run:
```sh
$ sudo pacman -S aspell-en
sudo pacman -S aspell-en
```
On **Debian**, **Ubuntu**:
```sh
$ sudo apt-get install aspell-en
sudo apt-get install aspell-en
```
On **Fedora**:
```sh
$ sudo dnf install aspell-en
sudo dnf install aspell-en
```
On **RHEL**/**CentOS**:
```sh
$ sudo yum install aspell-en
sudo yum install aspell-en
```

Once installed all dictionaries, you can ensure whether the required dictionaries are available or not using command:
```sh
$ aspell dicts
aspell dicts
en
en-variant_0
en-variant_1
Expand Down
18 changes: 9 additions & 9 deletions docs/content/03_Spellcheckers/02_Hunspell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ Hunspell is available in the default repositories of most Linux distributions, s
On **Arch Linux** and derivatives like **Antergos**, **Manjaro Linux**, run:

```sh
$ sudo pacman -S hunspell
sudo pacman -S hunspell
```
On **Fedora**:
```sh
$ sudo dnf install hunspell
sudo dnf install hunspell
```
On **RHEL**, **CentOS**:
```sh
$ sudo yum install epel-release
sudo yum install epel-release

$ sudo yum install hunspell
```
On **Debian**, **Ubuntu**:
```sh
$ sudo apt-get install hunspell
sudo apt-get install hunspell
```

on **Mac OSX** with **Homebrew**:
Expand All @@ -41,20 +41,20 @@ By default, Hunspell won’t have any dictionaries. To add a dictionary, for exa

This can also be found in the default repositories. For instance, to add English dictionary on Arch linux, run:
```sh
$ sudo pacman -S hunspell-en-us
sudo pacman -S hunspell-en-us
```

On **Debian**, **Ubuntu**:
```sh
$ sudo apt-get install hunspell-en-us
sudo apt-get install hunspell-en-us
```
On **Fedora**:
```sh
$ sudo dnf install hunspell-en-us
sudo dnf install hunspell-en-us
```
On **RHEL**/**CentOS**:
```sh
$ sudo yum install hunspell-en-us
sudo yum install hunspell-en-us
```

on **Mac OSX**:
Expand All @@ -63,7 +63,7 @@ Download dictionaries from http://wordlist.aspell.net/dicts/ and put them to `/L

Once installed all dictionaries, you can ensure whether the required dictionaries are available or not using command:
```sh
$ hunspell -D
hunspell -D
/usr/share/hunspell/en_US
...
```
Expand Down
8 changes: 4 additions & 4 deletions docs/content/07_Contributing/01_Tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ The most convenient way to do it is by using Docker and avoid polluting your loc
Requires `docker` and `docker-compose` to be installed (tested on Linux).

```sh
$ make build # build container images
$ make setup # start spellcheckers container
$ make tests-dox
make build # build container images
make setup # start spellcheckers container
make tests-dox
```

You can also specify PHP version, dependency version target and if you want coverage. Coverage is only supported by PHP 7.2 for now.

```sh
$ PHP_VERSION=7.2 DEPS=LOWEST WITH_COVERAGE="true" make tests-dox
PHP_VERSION=7.2 DEPS=LOWEST WITH_COVERAGE="true" make tests-dox
```

Run `make help` to list all available tasks.
Expand Down