aboutsummaryrefslogtreecommitdiff
path: root/pages/guide/01-quickstart.md
diff options
context:
space:
mode:
authorHayleigh Thompson <me@hayleigh.dev>2024-05-29 13:14:56 +0200
committerHayleigh Thompson <me@hayleigh.dev>2024-05-30 19:18:05 +0200
commit69ccbd64cac762bcef1ceb6c08953160b09ec99d (patch)
tree0a7f809fbce5328e10d9d273859a478b15f6800a /pages/guide/01-quickstart.md
parent1a31a7773c6eedf6f52e5215765138bc49fd1323 (diff)
downloadlustre-69ccbd64cac762bcef1ceb6c08953160b09ec99d.tar.gz
lustre-69ccbd64cac762bcef1ceb6c08953160b09ec99d.zip
:memo: Add note about inotify-tools for linux users of lustre_dev_tools.
Diffstat (limited to 'pages/guide/01-quickstart.md')
-rw-r--r--pages/guide/01-quickstart.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/pages/guide/01-quickstart.md b/pages/guide/01-quickstart.md
index 799e5d7..642c246 100644
--- a/pages/guide/01-quickstart.md
+++ b/pages/guide/01-quickstart.md
@@ -74,6 +74,12 @@ Lustre has some official development tooling published in the
[`lustre_dev_tools`](https://hexdocs.pm/lustre_dev_tools/) package. Most projects
will probably want to add those too!
+> **Note**: the lustre_dev_tools development server watches your filesystem for
+> changes to your gleam code and can automatically reload the browser. For linux
+> users this requires [inotify-tools](https://github.com/inotify-tools/inotify-tools)
+> be installed. If you do not or cannot install this, the development server will
+> still run but it will not watch your files for changes.
+
```sh
gleam add --dev lustre_dev_tools
```