|
| 1 | + |
1 | 2 | <br />
|
2 | 3 | <div align="center">
|
3 | 4 | <a href="https://github.com/blopker/codebook"> <img
|
@@ -72,6 +73,14 @@ Suggestions will appear in files opened, and
|
72 | 73 | [space-mode](https://docs.helix-editor.com/keymap.html#space-mode) `a` key
|
73 | 74 | binding can be used to accept suggestions.
|
74 | 75 |
|
| 76 | +### Other Editors |
| 77 | + |
| 78 | +Any editor that implements the Language Server Protocol should be compatible with Codebook. To get started, follow the [installation instructions](#installation), then consult your editor's documentation to learn how to configure and enable a new language server. For your reference, the following command starts the server such that it listens on `STDIN` and emits on `STDOUT`: |
| 79 | + |
| 80 | +```sh |
| 81 | +codebook-lsp serve |
| 82 | +``` |
| 83 | + |
75 | 84 | ## About
|
76 | 85 |
|
77 | 86 | Codebook is a spell checker for code. It binds together the venerable Tree Sitter and the fast spell checker [Spellbook](https://github.com/helix-editor/spellbook). Included is a Language Server for use in (theoretically) any editor. Everything is done in Rust to keep response times snappy and memory usage _low_.
|
@@ -109,6 +118,39 @@ Codebook is in active development. As better dictionaries are added, words that
|
109 | 118 |
|
110 | 119 | If Codebook is not marking issues you think it should, please file a GitHub issue!
|
111 | 120 |
|
| 121 | +## Installation |
| 122 | + |
| 123 | +If you are a Zed user, you may skip this step and consult the [Zed section](#zed) of this document. Otherwise, you will need to install the `codebook-lsp` binary and make it available on your `$PATH`. You have a number of options to do this. |
| 124 | + |
| 125 | +### Manual |
| 126 | + |
| 127 | +1. Download the latest release for your architecture from the [releases](https://github.com/blopker/codebook/releases) page. |
| 128 | +2. Extract the binary from the tarball, and move it somewhere on your system `$PATH`. |
| 129 | + - `~/.local/bin/codebook-lsp` |
| 130 | + - `/usr/bin/codebook-lsp` |
| 131 | + - Etc... |
| 132 | + |
| 133 | +### Eget Installation |
| 134 | + |
| 135 | +You can install the latest release using [eget](https://github.com/zyedidia/eget): |
| 136 | + |
| 137 | +```sh |
| 138 | +eget blopker/codebook |
| 139 | +``` |
| 140 | + |
| 141 | +### Arch User Repository |
| 142 | + |
| 143 | +The binary release is available on the AUR under the [codebook-bin](aur.archlinux.org/packages/codebook-bin) package. Arch users can easily install it with their favorite AUR helper, such as [paru](https://github.com/Morganamilo/paru): |
| 144 | + |
| 145 | +```sh |
| 146 | +paru -S codebook-bin |
| 147 | +``` |
| 148 | + |
| 149 | +### From Source |
| 150 | + |
| 151 | +You may also build `codebook` from source by cloning the repository and running `make build`. |
| 152 | + |
| 153 | + |
112 | 154 | ## Configuration
|
113 | 155 |
|
114 | 156 | Codebook supports both global and project-specific configuration. Configuration files use the TOML format, with project settings overriding global ones.
|
|
0 commit comments