Skip to content

Commit

Permalink
docs(README.md): Add package desc under title
Browse files Browse the repository at this point in the history
  • Loading branch information
jcs090218 authored May 1, 2023
1 parent d447161 commit 6e13ad0
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,20 @@
<img align="right" src="./etc/logo.png" with="115" height="55">

# eglot-ltex
> Eglot Clients for LTEX
[![CI](https://github.com/emacs-languagetool/eglot-ltex/actions/workflows/test.yml/badge.svg)](https://github.com/emacs-languagetool/eglot-ltex/actions/workflows/test.yml)

`Eglot` client leveraging [LTEX Language Server](https://github.com/valentjn/ltex-ls).

## :floppy_disk: Quickstart
## 💾 Quickstart

### :mag: Step 1. Install `LTEX` language server through LTEX's homepage
### 🔍 Step 1. Install `LTEX` language server through LTEX's homepage
> Link https://github.com/valentjn/ltex-ls
Extract the `.tar.gz` file to any location you want.

### :mag: Step 2. Configure your Emacs configuration
### 🔍 Step 2. Configure your Emacs configuration

Consider adding this to your configuration.

Expand All @@ -30,7 +31,7 @@ Consider adding this to your configuration.
(setq eglot-languagetool-server-path "path/to/ltex-ls-XX.X.X/"))
```

## :wrench: Configuration
## 🔧 Configuration

Create `.dir-locals.el` file in the project root directory to configure the ltex
language server, for example:
Expand Down

0 comments on commit 6e13ad0

Please sign in to comment.