From 39465b47ddcf690db3f3ad2b10dbe3dc99b702c3 Mon Sep 17 00:00:00 2001 From: Liam Galvin Date: Tue, 25 Feb 2020 16:18:32 +0000 Subject: [PATCH 1/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 44ccf6f..a2ff9f9 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ A customisable terminal status bar with universal shell/terminal compatibility. ## Installation +*NOTE* This is still very experimental. I'm using it locally without any problems right now, but there's still a lot of testing and tweaking to do. Feel free to try it out, but get ready for some potential bugginess! + ```bash curl -s "https://raw.githubusercontent.com/liamg/shox/master/scripts/install.sh" | bash ``` From 8c27a66579d344df82b4fbfd9cca497fbc06a5fe Mon Sep 17 00:00:00 2001 From: Liam Galvin Date: Tue, 25 Feb 2020 16:19:04 +0000 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a2ff9f9..8893af4 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A customisable terminal status bar with universal shell/terminal compatibility. ## Installation -*NOTE* This is still very experimental. I'm using it locally without any problems right now, but there's still a lot of testing and tweaking to do. Feel free to try it out, but get ready for some potential bugginess! +**NOTE** This is still very experimental. I'm using it locally without any problems right now, but there's still a lot of testing and tweaking to do. Feel free to try it out, but get ready for some potential bugginess! ```bash curl -s "https://raw.githubusercontent.com/liamg/shox/master/scripts/install.sh" | bash From fcf5f588f607967ce5bb873fbf055262b084b3be Mon Sep 17 00:00:00 2001 From: Liam Galvin Date: Tue, 25 Feb 2020 16:20:58 +0000 Subject: [PATCH 3/3] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8893af4..187d2b4 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,11 @@ A customisable terminal status bar with universal shell/terminal compatibility. **NOTE** This is still very experimental. I'm using it locally without any problems right now, but there's still a lot of testing and tweaking to do. Feel free to try it out, but get ready for some potential bugginess! ```bash -curl -s "https://raw.githubusercontent.com/liamg/shox/master/scripts/install.sh" | bash +curl -s "https://raw.githubusercontent.com/liamg/shox/master/scripts/install.sh" | sudo bash ``` +If you don't like to pipe to sudo - as well you shouldn't - you can remove the `sudo` above, but you'll have to add the shox dir to your `PATH` env var manually, as instructed by the installer. + ## Configuration The shox config file should be created at `$XDG_CONFIG_HOME/shox/config.yaml`, which is usually `~/.config/shox/config.yaml`. You can alternatively create it at `~/.shox.yaml`