From 5c2e1787a882da097dfd02bc7188209db73a6875 Mon Sep 17 00:00:00 2001 From: Hayleigh Thompson Date: Thu, 20 Jun 2024 00:00:48 +0100 Subject: [PATCH] :memo: Document gleam_json awkwardness. --- README.md | 6 +++++- src/lustre/dev.gleam | 7 ++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6fe0605..e674653 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,10 @@ package. Lustre's dev tools are published on [Hex](https://hex.pm/packages/lustre_dev_tools)! You can add them as a dev dependency to your Gleam projects from the command line: +> **Note**: currently one of lustre_dev_tools' dependencies is not compatible with +> the most recent version of `gleam_json`, making it impossible to install. To fix +> this, add `gleam_json = "1.0.1"` as a dependency in your `gleam.toml` file. + ```sh gleam add lustre_dev_tools --dev ``` @@ -105,7 +109,7 @@ and options. Here's a brief overview of the commands provided by Lustre's dev to Tailwind binary. Lustre will automatically use this to compile your styles if it detects a `tailwind.config.js` in your project but will not download it automatically. Be sure to add the following to your root level `index.html` - + `` - `lustre/dev build` - Commands to build different kinds of Lustre application. diff --git a/src/lustre/dev.gleam b/src/lustre/dev.gleam index 77ceb75..7a37a38 100644 --- a/src/lustre/dev.gleam +++ b/src/lustre/dev.gleam @@ -1,9 +1,14 @@ -//// Lustres Dev Tools is a CLI (Command Line Interface) that provides a set of commands +//// Lustre's Dev Tools is a CLI (Command Line Interface) that provides a set of commands //// for running and building Lustre projects. If you're familiar with frontend Web //// development, you could consider the Lustre Dev Tools as something similar to //// [vite](https://vitejs.dev) but built right into the framework! If you're not //// familiar with what these tools are used for... then read on. //// +//// > **Note**: currently one of lustre_dev_tools' dependencies is not compatible +//// > with the most recent version of `gleam_json`, making it impossible to install. +//// > To fix this, add `gleam_json = "1.0.1"` as a dependency in your `gleam.toml` +//// > file. +//// //// Lustre Dev Tools is written in Gleam and requires **Erlang** to be installed even //// if you are only building a JavaScript project. Most methods of installing Gleam //// will guide you through installing Erlang too, but make sure you have it installed