From 01ae70e3433dff3ed8e9dc0e90f4242549a92d62 Mon Sep 17 00:00:00 2001 From: "Francesco Bianco (yafb)" Date: Fri, 20 Dec 2024 08:58:21 +0100 Subject: [PATCH 1/8] Update _config.yml --- docs/_config.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index d74c79f..6705a24 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -13,7 +13,8 @@ aux_links: footer_content: > © 2024 Francesco Bianco. All rights reserved. - + + markdown: kramdown From 968cc09b1366a2293134d9a65955bc755b1a64f7 Mon Sep 17 00:00:00 2001 From: francescobianco Date: Sat, 4 Jan 2025 10:51:52 +0100 Subject: [PATCH 2/8] shellcheck --- docs/miscellaneous/04-installation.md | 92 +++++++++++++++++++ .../{04-examples.md => 05-examples.md} | 2 +- .../{05-guidelines.md => 06-guidelines.md} | 2 +- .../{06-lectures.md => 07-lectures.md} | 2 +- .../{07-memes.md => 08-memes.md} | 2 +- docs/root/01-get-started.md | 2 + 6 files changed, 98 insertions(+), 4 deletions(-) create mode 100644 docs/miscellaneous/04-installation.md rename docs/miscellaneous/{04-examples.md => 05-examples.md} (98%) rename docs/miscellaneous/{05-guidelines.md => 06-guidelines.md} (99%) rename docs/miscellaneous/{06-lectures.md => 07-lectures.md} (96%) rename docs/miscellaneous/{07-memes.md => 08-memes.md} (96%) diff --git a/docs/miscellaneous/04-installation.md b/docs/miscellaneous/04-installation.md new file mode 100644 index 0000000..6a0f120 --- /dev/null +++ b/docs/miscellaneous/04-installation.md @@ -0,0 +1,92 @@ +--- +layout: default +title: Installation +permalink: /installation/ +nav_order: 04 +parent: Miscellaneous +compliance: 1 +--- + +# Installation Guide + +The installation of the stable version of Mush follows a standard approach, which is straightforward and ideal for most users. Installing the stable release ensures a reliable and tested version suitable for general use. Here’s the standard method: + +#### Installing the stable version + +The easiest way to get Mush is to install the current stable release from GitHub using `curl`. This method will also create a directory at `$HOME/.mush/bin`, where you can host the scripts you’ll install subsequently. + +On Linux and macOS systems, this is done as follows: + +```bash +$ curl get.javanile.org/mush | sh +``` + +However, in some cases, alternative installation methods may be required depending on your specific needs. For example: + +- Running Mush in **specialized environments**, such as servers with unique configurations. +- Using Mush in **non-Unix-based environments**, like Windows. +- Accessing **advanced or experimental features** under active development or in testing. + +Below are the details for installing Mush in such scenarios. + +## Installing from the development branch + +To test the latest features and changes that have not yet been included in the stable release, you can install Mush from its development branch. This method is intended for advanced users or contributors who want to test new functionalities. + +```bash +curl get.javanile.org/mush | bash -s -- --branch BRANCHNAME +``` + +Valid branch names include `develop` and `zsh`. For a complete list of available branches, visit [this page](https://github.com/javanile/mush/branches/all). + +## Installing from source + +If you need to build Mush from source, either to customize the tool or to integrate it into specific environments, follow these steps: + +1. Clone the repository: + ```bash + $ git clone https://github.com/javanile/mush.git + ``` +2. Navigate to the directory: + ```bash + $ cd mush + ``` +3. Build and install: + ```bash + $ ./install.sh + ``` + +Ensure you have the necessary dependencies installed beforehand. + +## Installing on Windows + +For Windows users, Mush can be installed using **Windows Subsystem for Linux (WSL)** or natively. Here's how: + +- **Using WSL** (recommended): + 1. Enable WSL on your system and install a Linux distribution (e.g., Ubuntu). + 2. Follow the standard installation instructions for Linux. + +- **Installing natively** (experimental): + 1. Download the latest release from [GitHub](https://github.com/javanile/mush/releases). + 2. Extract the files and add the executable to your PATH. + +> Note: For optimal performance and compatibility, using WSL is the preferred option. + +## Installing in other environments + +If you’re using Mush in non-standard environments, such as embedded systems, containers, or highly restricted servers, the installation process might require customization: + +1. Ensure that the environment supports a shell interpreter (e.g., bash, zsh). +2. Download the Mush script manually: + ```bash + $ curl -o mush.sh get.javanile.org/mush + ``` +3. Adapt the script to your environment’s requirements (e.g., custom paths, dependencies). +4. Execute the script: + ```bash + $ sh mush.sh + ``` + +--- + +For further assistance or specific use cases, feel free to check the documentation or reach out to the Mush community. \ No newline at end of file diff --git a/docs/miscellaneous/04-examples.md b/docs/miscellaneous/05-examples.md similarity index 98% rename from docs/miscellaneous/04-examples.md rename to docs/miscellaneous/05-examples.md index f46b614..5a8231f 100644 --- a/docs/miscellaneous/04-examples.md +++ b/docs/miscellaneous/05-examples.md @@ -2,7 +2,7 @@ layout: default title: Examples permalink: /examples/ -nav_order: 04 +nav_order: 05 parent: Miscellaneous compliance: 1 --- diff --git a/docs/miscellaneous/05-guidelines.md b/docs/miscellaneous/06-guidelines.md similarity index 99% rename from docs/miscellaneous/05-guidelines.md rename to docs/miscellaneous/06-guidelines.md index 172c628..055dbf2 100644 --- a/docs/miscellaneous/05-guidelines.md +++ b/docs/miscellaneous/06-guidelines.md @@ -2,7 +2,7 @@ layout: default title: Guidelines permalink: /guidelines/ -nav_order: 05 +nav_order: 06 parent: Miscellaneous compliance: 1 --- diff --git a/docs/miscellaneous/06-lectures.md b/docs/miscellaneous/07-lectures.md similarity index 96% rename from docs/miscellaneous/06-lectures.md rename to docs/miscellaneous/07-lectures.md index 305f18c..a48871e 100644 --- a/docs/miscellaneous/06-lectures.md +++ b/docs/miscellaneous/07-lectures.md @@ -2,7 +2,7 @@ layout: default title: Lectures permalink: /lectures/ -nav_order: 04 +nav_order: 7 parent: Miscellaneous --- diff --git a/docs/miscellaneous/07-memes.md b/docs/miscellaneous/08-memes.md similarity index 96% rename from docs/miscellaneous/07-memes.md rename to docs/miscellaneous/08-memes.md index ff4a7d3..5344193 100644 --- a/docs/miscellaneous/07-memes.md +++ b/docs/miscellaneous/08-memes.md @@ -2,7 +2,7 @@ layout: default title: Memes permalink: /memes/ -nav_order: 07 +nav_order: 8 parent: Miscellaneous --- diff --git a/docs/root/01-get-started.md b/docs/root/01-get-started.md index ec3a692..856ae17 100644 --- a/docs/root/01-get-started.md +++ b/docs/root/01-get-started.md @@ -28,6 +28,8 @@ On Linux and macOS systems, this is done as follows: $ curl get.javanile.org/mush | sh ``` +For other installation methods, please visit the [Installation Guide](/miscellaneous/installation). + ## First steps with Mush This section provides a quick sense for the `mush` command line tool. We From 63df33f947395683566c07b21e494f2bf5e4dfe0 Mon Sep 17 00:00:00 2001 From: francescobianco Date: Sat, 4 Jan 2025 10:54:29 +0100 Subject: [PATCH 3/8] Small fix --- Makefile | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Makefile b/Makefile index 67d4520..aa7ad86 100644 --- a/Makefile +++ b/Makefile @@ -86,6 +86,14 @@ ci-shellcheck: @git commit -am "shellcheck" @git push +## ======= +## Develop +## ======= + +dev-push: + @git add . + @git commit -am "Small fix" || true + @git push ## ==== ## Test From 151e928fb2818bca4a0643e9e3c7bdab4f50875d Mon Sep 17 00:00:00 2001 From: francescobianco Date: Sat, 4 Jan 2025 10:59:07 +0100 Subject: [PATCH 4/8] Small fix --- docs/root/01-get-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/root/01-get-started.md b/docs/root/01-get-started.md index 856ae17..8ec3d47 100644 --- a/docs/root/01-get-started.md +++ b/docs/root/01-get-started.md @@ -28,7 +28,7 @@ On Linux and macOS systems, this is done as follows: $ curl get.javanile.org/mush | sh ``` -For other installation methods, please visit the [Installation Guide](/miscellaneous/installation). +For other installation methods, please visit the [installation](/installation). ## First steps with Mush From 5cb2bdeaaaf31a32c2a32bd156c33293a49a0b8e Mon Sep 17 00:00:00 2001 From: francescobianco Date: Sat, 4 Jan 2025 10:59:43 +0100 Subject: [PATCH 5/8] Small fix --- docs/root/01-get-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/root/01-get-started.md b/docs/root/01-get-started.md index 8ec3d47..21a4ca9 100644 --- a/docs/root/01-get-started.md +++ b/docs/root/01-get-started.md @@ -28,7 +28,7 @@ On Linux and macOS systems, this is done as follows: $ curl get.javanile.org/mush | sh ``` -For other installation methods, please visit the [installation](/installation). +For other installation methods, please visit the [installation page](/installation). ## First steps with Mush From be56d8da26a29645501dbc2d429713bab3fff006 Mon Sep 17 00:00:00 2001 From: francescobianco Date: Sat, 4 Jan 2025 11:07:44 +0100 Subject: [PATCH 6/8] Small fix --- docs/miscellaneous/04-installation.md | 2 +- docs/root/01-get-started.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/miscellaneous/04-installation.md b/docs/miscellaneous/04-installation.md index 6a0f120..934b4e4 100644 --- a/docs/miscellaneous/04-installation.md +++ b/docs/miscellaneous/04-installation.md @@ -7,7 +7,7 @@ parent: Miscellaneous compliance: 1 --- -# Installation Guide +# Installation The installation of the stable version of Mush follows a standard approach, which is straightforward and ideal for most users. Installing the stable release ensures a reliable and tested version suitable for general use. Here’s the standard method: diff --git a/docs/root/01-get-started.md b/docs/root/01-get-started.md index 21a4ca9..cd97a23 100644 --- a/docs/root/01-get-started.md +++ b/docs/root/01-get-started.md @@ -28,7 +28,7 @@ On Linux and macOS systems, this is done as follows: $ curl get.javanile.org/mush | sh ``` -For other installation methods, please visit the [installation page](/installation). +For other installation methods, please visit the [installation](/installation) page. ## First steps with Mush From c2e92b8d3b8dde636fbea42d9e1719211a5c5025 Mon Sep 17 00:00:00 2001 From: francescobianco Date: Sat, 4 Jan 2025 11:45:59 +0100 Subject: [PATCH 7/8] Small fix --- src/main.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main.sh b/src/main.sh index f519f44..fe45272 100644 --- a/src/main.sh +++ b/src/main.sh @@ -11,7 +11,7 @@ module package_managers module registry module tasks -VERSION="Mush 0.2.0 (2024-03-21)" +VERSION="Mush 0.2.0 (2025-01-05 develop)" parser_definition() { setup REST error:args_error help:usage abbr:true -- "Shell's build system" '' From 9e6f1bc47573f9b41c2f04ecc9503da38c1bebbe Mon Sep 17 00:00:00 2001 From: francescobianco Date: Sat, 4 Jan 2025 11:50:20 +0100 Subject: [PATCH 8/8] Small fix --- src/main.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main.sh b/src/main.sh index fe45272..d4113b8 100644 --- a/src/main.sh +++ b/src/main.sh @@ -11,7 +11,7 @@ module package_managers module registry module tasks -VERSION="Mush 0.2.0 (2025-01-05 develop)" +VERSION="Mush 0.2.0 (2025-01-05 main)" parser_definition() { setup REST error:args_error help:usage abbr:true -- "Shell's build system" ''