Skip to content

Commit 6c5cbe9

Browse files
authored
docs: add getting started section to development.md (#94)
Explains how to build a development release of burrito and why `MIX_ENV=dev` is needed.
1 parent 0767fb4 commit 6c5cbe9

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

pages/development.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# Development
22

3+
## Getting Started
4+
5+
First follow the [installation instructions](installation.md) to install the
6+
required prerequisites.
7+
8+
To build Expert, run:
9+
10+
```sh
11+
MIX_ENV=dev just release-local
12+
```
13+
14+
>[!IMPORTANT]
15+
> We set `MIX_ENV=dev` to disable Burrito's caching mechanisms. This provides a
16+
> smoother development experience but expect server load times to be slightly
17+
> longer.
18+
19+
You may point your editor's LSP configuration to path provided by Burrito, eg:
20+
21+
```sh
22+
<your-repo>/apps/expert/burrito_out/expert_linux_amd64
23+
```
24+
325
## Logging
426

527
When expert starts up, it creates a `.expert` directory in the root

0 commit comments

Comments
 (0)