Skip to content

Commit

Permalink
📝 Document gleam_json awkwardness.
Browse files Browse the repository at this point in the history
  • Loading branch information
hayleigh-dot-dev committed Jun 19, 2024
1 parent 97a6822 commit 5c2e178
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down Expand Up @@ -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`

`<link rel="stylesheet" type="text/css" href="./priv/static/my_app.css" />`

- `lustre/dev build` - Commands to build different kinds of Lustre application.
Expand Down
7 changes: 6 additions & 1 deletion src/lustre/dev.gleam
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 5c2e178

Please sign in to comment.