aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Lance Borden 2024-09-25 13:34:26 -0400
committerGravatar GitHub 2024-09-25 13:34:26 -0400
commit0539674ed37f8ae7fa71762327a39f79417d5e33 (patch)
tree19f33592383444534db45707f8a0aba027f4d6cc /README.md
parentfixed lua api exit status issue (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index a6d4689..2c04d86 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,9 @@
Lunar Shell (lush) is an open source unix shell with a single goal in mind. That goal is to offer the ability to write shell scripts for your operating system entirely in Lua. The Lua scripting language has many powerful features that allow for more control in the hands of the user to automate tasks on their machine.
+> [!NOTE]
+> Lunar Shell is very early in development and may be lacking in many features common of other Linux shells.
+
## Compiling/Installation
Clone the repo and run the install script to get the development version. If you want the most recent stable version download the source code zip from the most recent [release](https://github.com/BanceDev/lush/releases). Extract it and run the install script. This will also automatically set your system shell to Lunar Shell, you will need to log out and back in for the changes to take effect.