Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jcs090218 authored Dec 11, 2023
1 parent 807899b commit 342a747
Showing 1 changed file with 64 additions and 5 deletions.
69 changes: 64 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[![CI](https://github.com/emacs-languagetool/flycheck-languagetool/actions/workflows/test.yml/badge.svg)](https://github.com/emacs-languagetool/flycheck-languagetool/actions/workflows/test.yml)

## :floppy_disk: Installation
## 💾 Installation

The instruction to use this plugin.

Expand All @@ -27,26 +27,26 @@ The instruction to use this plugin.

4. :tada: Done! Now open a text file and hit `M-x flycheck-mode`!

## :wrench: Configuration
## 🔧 Configuration

* `flycheck-languagetool-url`
* `flycheck-languagetool-server-jar`
* `flycheck-languagetool-server-port`
* `flycheck-languagetool-active-modes`
* `flycheck-languagetool-language` (Default `"en-US"`)

### :book: Spellchecking
### 📖 Spellchecking

LanguageTool’s spellchecking will be disabled if
[`flyspell-mode`](https://www.gnu.org/software/emacs/manual/html_node/emacs/Spelling.html)
or [`jinx-mode`](https://github.com/minad/jinx) is active. Disable those
modes if you would prefer LanguageTool to check for spelling mistakes.

## Troubleshooting
## Troubleshooting

You can find log messages from a local LanguageTool server in a hidden buffer called ` *LanguageTool server*`.

## Contribute
## 🛠️ Contribute

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
[![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple)](https://github.com/bbatsov/emacs-lisp-style-guide)
Expand All @@ -57,3 +57,62 @@ If you would like to contribute to this project, you may either
clone and make pull requests to this repository. Or you can
clone the project and establish your own branch of this tool.
Any methods are welcome!

### 🔬 Development

To run the test locally, you will need the following tools:

- [Eask](https://emacs-eask.github.io/)
- [Make](https://www.gnu.org/software/make/) (optional)

Install all dependencies and development dependencies:

```sh
$ eask install-deps --dev
```

To test the package's installation:

```sh
$ eask package
$ eask install
```

To test compilation:

```sh
$ eask compile
```

**🪧 The following steps are optional, but we recommend you follow these lint results!**

The built-in `checkdoc` linter:

```sh
$ eask lint checkdoc
```

The standard `package` linter:

```sh
$ eask lint package
```

*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*

## ⚜️ License

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.

See [`LICENSE`](./LICENSE.txt) for details.

0 comments on commit 342a747

Please sign in to comment.