From 536b24c9396855448ff202ad97a8071553e95ce7 Mon Sep 17 00:00:00 2001 From: Filip Tibell Date: Wed, 25 Jan 2023 14:56:15 -0500 Subject: [PATCH] Improve readme formatting --- README.md | 32 +++++++++++++------------------- 1 file changed, 13 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 17d58fc..9c8d2b2 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,14 @@

Lune 🌙

- -
- Current Lune library version - CI status - Release status - Current Lune library version -
- -
- -A standalone Luau script runner - -🚀 Use the ergonomics and readability of Luau for your shell scripts 🚀 - +
+ Current Lune library version + CI status + Release status + Current Lune library version +
+
A standalone Luau script runner +
🚀 Use the ergonomics and readability of Luau for your shell scripts 🚀
@@ -35,7 +29,7 @@ You can also download pre-built binaries for most systems directly from the GitH ## ✏️ Writing Lune Scripts -Check out the examples on how to write a script in the [.lune](.lune) folder !
+Check out the examples on how to write a script in the [.lune](.lune) folder !
A great starting point and walkthrough of Lune can be found in the [Hello, Lune](.lune/hello_lune.luau) example.
@@ -196,7 +190,7 @@ An example of these settings can be found in the [.vscode](.vscode) folder in th 2. Use either `std = "luau+lune"`, or `std = "roblox+lune"` if your project also contains Roblox-specific code, in your `selene.toml` configuration file
-
+
**_NOTE:_** _It is highly recommended to add any type definition files to your `.gitignore` and to only download them using these commands, since this guarantees that you have type definitions compatible with your installed version of Lune._ @@ -216,7 +210,7 @@ This will look for the file `script-name.luau` in a few locations: - The folder `lune` in the current directory, if it exists - The folder `.lune` in the current directory, if it exists -If you don't want Lune to look in sub-directories you can provide a full file path with the file extension included, instead of only the file name.
+If you don't want Lune to look in sub-directories you can provide a full file path with the file extension included, instead of only the file name.
## 💭 Additional Commands @@ -224,8 +218,8 @@ If you don't want Lune to look in sub-directories you can provide a full file pa lune --list ``` -Lists all scripts found in `lune` or `.lune` directories, including description comments if they exist.
-If both `lune` and `.lune` directories exist, only the former will have its scripts listed, which is consistent with the behavior of running scripts. +Lists all scripts found in `lune` or `.lune` directories, including any top-level description comments.
+Lune description comments are always written at the top of a file and start with a lua-style comment arrow (`-->`). ---