aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar BanceDev 2025-02-13 11:56:52 -0500
committerGravatar BanceDev 2025-02-13 11:56:52 -0500
commit17aadc35445c08572edcc9df826ade5d74cb4e17 (patch)
tree60fe317e97bc4c5304d24355fae32e2576349545 /README.md
parentv0.3.1 (diff)
added ability to configure alternate shell
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index 0394983..35b1db1 100644
--- a/README.md
+++ b/README.md
@@ -14,10 +14,23 @@
Lunar Shell (lush) is an open source Linux 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.
+> Lunar Shell is very early in development and may be lacking in features common of other Linux shells.
## Compiling/Installation
+### Arch Linux
+
+```
+yay -Sy lush-shell
+echo "/usr/bin/lush" | sudo tee -a /etc/shells >/dev/null
+```
+
+### Debain/Ubuntu/Mint
+
+There is a deb package in [releases](https://github.com/BanceDev/lush/releases)
+
+### Compile and Install from Source
+
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.
```
@@ -26,7 +39,7 @@ cd lush
sh install.sh
```
-To update Lunar Shell pull the repo/download the newest release and then run the install script again.
+To update Lunar Shell pull the repo/download the newest release and then run the update.sh script.
## Lua Shell Scripting