Miguel Raz Guzmán Macedo
35ae2f5b2b
I ran [proselint](https://github.com/amperser/proselint) (recommended by cURL author [Daniel Stenberg](https://daniel.haxx.se/blog/2022/09/22/taking-curl-documentation-quality-up-one-more-notch/)) against all the `.md` files in the codebase to see if I could fix some easy typos. The tool is noisier than I would like and picking up the overrides to the default config in a `.proselintrc.json` was much harder than I expected. There's many other small nits [1] that I believe are best left to your docs czar whenever they want to consider incorporating a tool like this into big releases or CI, but these seemed like small wins for now to open a conversation about a tool like proselint. --- [1]: Such nits include - incosistent 1 or 2 spaces - "color" vs "colour" - ab/use of `very` - awkward or superfluous phrasing. Release Notes: - N/A Signed-off-by: mrg <miguelraz@ciencias.unam.mx>
37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
# OCaml
|
|
|
|
OCaml support is available through the [OCaml extension](https://github.com/zed-extensions/ocaml).
|
|
|
|
- Tree-sitter: [tree-sitter/tree-sitter-ocaml](https://github.com/tree-sitter/tree-sitter-ocaml)
|
|
- Language Server: [ocaml/ocaml-lsp](https://github.com/ocaml/ocaml-lsp)
|
|
|
|
## Setup Instructions
|
|
|
|
If you have the development environment already setup, you can skip to [Launching Zed](#launching-zed)
|
|
|
|
### Using Opam
|
|
|
|
Opam is the official package manager for OCaml and is highly recommended for getting started with OCaml. To get started using Opam, please follow the instructions provided [here](https://ocaml.org/install).
|
|
|
|
Once you install opam and setup a switch with your development environment as per the instructions, you can proceed.
|
|
|
|
### Launching Zed
|
|
|
|
By now you should have `ocamllsp` installed, you can verify so by running
|
|
|
|
```sh
|
|
ocamllsp --help
|
|
```
|
|
|
|
in your terminal. If you get a help message, you're good to go. If not, please revisit the installation instructions for `ocamllsp` and ensure it's properly installed.
|
|
|
|
With that aside, we can now launch Zed. Given how the OCaml package manager works, we require you to run Zed from the terminal, so please make sure you install the [Zed cli](https://zed.dev/features#cli) if you haven't already.
|
|
|
|
Once you have the cli, simply from a terminal, navigate to your project and run
|
|
|
|
```sh
|
|
zed .
|
|
```
|
|
|
|
Voilà! You should have Zed running with OCaml support, no additional setup required.
|