From 2a81dc58dba90382a3b6b5dce41709aea45d917d Mon Sep 17 00:00:00 2001 From: Oliver Marriott Date: Sat, 30 Aug 2025 14:26:01 +1000 Subject: [PATCH] docs: add getting started section to development.md Explains how to build a development release of burrito and why `MIX_ENV=dev` is needed. --- pages/development.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/pages/development.md b/pages/development.md index 5635ba22..3d5cd1d3 100644 --- a/pages/development.md +++ b/pages/development.md @@ -1,5 +1,27 @@ # Development +## Getting Started + +First follow the [installation instructions](installation.md) to install the +required prerequisites. + +To build Expert, run: + +```sh +MIX_ENV=dev just release-local +``` + +>[!IMPORTANT] +> We set `MIX_ENV=dev` to disable Burrito's caching mechanisms. This provides a +> smoother development experience but expect server load times to be slightly +> longer. + +You may point your editor's LSP configuration to path provided by Burrito, eg: + +```sh +/apps/expert/burrito_out/expert_linux_amd64 +``` + ## Logging When expert starts up, it creates a `.expert` directory in the root