From 69ccbd64cac762bcef1ceb6c08953160b09ec99d Mon Sep 17 00:00:00 2001 From: Hayleigh Thompson Date: Wed, 29 May 2024 13:14:56 +0200 Subject: :memo: Add note about inotify-tools for linux users of lustre_dev_tools. --- README.md | 4 ++++ pages/guide/01-quickstart.md | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/README.md b/README.md index a13b271..29eabfc 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,10 @@ gleam add lustre Lustre also has a companion package containing development tooling that you might like to install: +> **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]() be installed + ```sh gleam add --dev lustre_dev_tools ``` 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 ``` -- cgit v1.2.3