Skip to content

Commit b7e219b

Browse files
Small fix
2 parents 565a8e3 + 9e6f1bc commit b7e219b

File tree

9 files changed

+106
-6
lines changed

9 files changed

+106
-6
lines changed

Makefile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,11 @@ dev-commit:
9595
@git commit -am "Development Commit" || true
9696
@git push
9797

98+
dev-push:
99+
@git add .
100+
@git commit -am "Small fix" || true
101+
@git push
102+
98103
## ====
99104
## Test
100105
## ====

docs/_config.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ aux_links:
1313

1414
footer_content: >
1515
© 2024 Francesco Bianco. All rights reserved.
16-
<script>document.querySelector('div.site-header a').innerHTML = '🍄 Mush<sup>ALPHA</sup>';</script>
16+
<script>document.querySelector('div.site-header a').innerHTML = '🍄 Mush<sup>ALPHA</sup>';</script>
17+
<script async src="https://scripts.simpleanalyticscdn.com/latest.js"></script>
1718
1819
markdown: kramdown
1920

docs/miscellaneous/04-installation.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
layout: default
3+
title: Installation
4+
permalink: /installation/
5+
nav_order: 04
6+
parent: Miscellaneous
7+
compliance: 1
8+
---
9+
10+
# Installation
11+
12+
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:
13+
14+
#### Installing the stable version
15+
16+
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.
17+
18+
On Linux and macOS systems, this is done as follows:
19+
20+
```bash
21+
$ curl get.javanile.org/mush | sh
22+
```
23+
24+
However, in some cases, alternative installation methods may be required depending on your specific needs. For example:
25+
26+
- Running Mush in **specialized environments**, such as servers with unique configurations.
27+
- Using Mush in **non-Unix-based environments**, like Windows.
28+
- Accessing **advanced or experimental features** under active development or in testing.
29+
30+
Below are the details for installing Mush in such scenarios.
31+
32+
## Installing from the development branch
33+
34+
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.
35+
36+
```bash
37+
curl get.javanile.org/mush | bash -s -- --branch BRANCHNAME
38+
```
39+
40+
Valid branch names include `develop` and `zsh`. For a complete list of available branches, visit [this page](https://github.com/javanile/mush/branches/all).
41+
42+
## Installing from source
43+
44+
If you need to build Mush from source, either to customize the tool or to integrate it into specific environments, follow these steps:
45+
46+
1. Clone the repository:
47+
```bash
48+
$ git clone https://github.com/javanile/mush.git
49+
```
50+
2. Navigate to the directory:
51+
```bash
52+
$ cd mush
53+
```
54+
3. Build and install:
55+
```bash
56+
$ ./install.sh
57+
```
58+
59+
Ensure you have the necessary dependencies installed beforehand.
60+
61+
## Installing on Windows
62+
63+
For Windows users, Mush can be installed using **Windows Subsystem for Linux (WSL)** or natively. Here's how:
64+
65+
- **Using WSL** (recommended):
66+
1. Enable WSL on your system and install a Linux distribution (e.g., Ubuntu).
67+
2. Follow the standard installation instructions for Linux.
68+
69+
- **Installing natively** (experimental):
70+
1. Download the latest release from [GitHub](https://github.com/javanile/mush/releases).
71+
2. Extract the files and add the executable to your PATH.
72+
73+
> Note: For optimal performance and compatibility, using WSL is the preferred option.
74+
75+
## Installing in other environments
76+
77+
If you’re using Mush in non-standard environments, such as embedded systems, containers, or highly restricted servers, the installation process might require customization:
78+
79+
1. Ensure that the environment supports a shell interpreter (e.g., bash, zsh).
80+
2. Download the Mush script manually:
81+
```bash
82+
$ curl -o mush.sh get.javanile.org/mush
83+
```
84+
3. Adapt the script to your environment’s requirements (e.g., custom paths, dependencies).
85+
4. Execute the script:
86+
```bash
87+
$ sh mush.sh
88+
```
89+
90+
---
91+
92+
For further assistance or specific use cases, feel free to check the documentation or reach out to the Mush community.

docs/miscellaneous/04-examples.md renamed to docs/miscellaneous/05-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Examples
44
permalink: /examples/
5-
nav_order: 04
5+
nav_order: 05
66
parent: Miscellaneous
77
compliance: 1
88
---

docs/miscellaneous/05-guidelines.md renamed to docs/miscellaneous/06-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Guidelines
44
permalink: /guidelines/
5-
nav_order: 05
5+
nav_order: 06
66
parent: Miscellaneous
77
compliance: 1
88
---

docs/miscellaneous/06-lectures.md renamed to docs/miscellaneous/07-lectures.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Lectures
44
permalink: /lectures/
5-
nav_order: 04
5+
nav_order: 7
66
parent: Miscellaneous
77
---
88

docs/miscellaneous/07-memes.md renamed to docs/miscellaneous/08-memes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Memes
44
permalink: /memes/
5-
nav_order: 07
5+
nav_order: 8
66
parent: Miscellaneous
77
---
88

docs/root/01-get-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ On Linux and macOS systems, this is done as follows:
2828
$ curl get.javanile.org/mush | sh
2929
```
3030

31+
For other installation methods, please visit the [installation](/installation) page.
32+
3133
## First steps with Mush
3234

3335
This section provides a quick sense for the `mush` command line tool. We

src/main.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ module package_managers
1111
module registry
1212
module tasks
1313

14-
VERSION="Mush 0.2.0 (2024-03-21)"
14+
VERSION="Mush 0.2.0 (2025-01-05 main)"
1515

1616
parser_definition() {
1717
setup REST error:args_error help:usage abbr:true -- "Shell's build system" ''

0 commit comments

Comments
 (0)