Skip to content

Commit

Permalink
shellcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
francescobianco committed Jan 4, 2025
1 parent 01ae70e commit 968cc09
Show file tree
Hide file tree
Showing 6 changed files with 98 additions and 4 deletions.
92 changes: 92 additions & 0 deletions docs/miscellaneous/04-installation.md
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Examples
permalink: /examples/
nav_order: 04
nav_order: 05
parent: Miscellaneous
compliance: 1
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Guidelines
permalink: /guidelines/
nav_order: 05
nav_order: 06
parent: Miscellaneous
compliance: 1
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Lectures
permalink: /lectures/
nav_order: 04
nav_order: 7
parent: Miscellaneous
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Memes
permalink: /memes/
nav_order: 07
nav_order: 8
parent: Miscellaneous
---

Expand Down
2 changes: 2 additions & 0 deletions docs/root/01-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 968cc09

Please # to comment.