Skip to content

Commit

Permalink
Add bootstrap instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
tomocafe committed Jun 5, 2024
1 parent b3f7a47 commit 532ac80
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,30 @@ This has only been tested for Linux. YMMV for other platforms.

## Installation

### From release tarball (recommended)
### Bootstrap (recommended)

Download and run the interactive bootstrap script to install the latest release. The script will allow you to enter a directory of your choice or you can select from prepopulated locations.

```bash
bash <(curl -sSL tomocafe.github.io/bash-boost/bootstrap.sh)
```

You can rerun this at any time to update an exsting installation.

### From release tarball

Download and extract the [latest release](https://github.com/tomocafe/bash-boost/releases), then follow the instructions in the Usage section.

### From `git`

Clone this repository and run `make`. For manual generation, `perl` and `pandoc` are required.
Clone this repository and run `make`. For manpage generation, `perl` and `pandoc` are required.

## Usage

Source the `bash-boost.sh` script and use `bb_load` to load modules and/or packages

```bash
source /path/to/bash-boost.sh
source /path/to/bash-boost/latest/bash-boost.sh

bb_load MODULE # e.g. cli
bb_load MODULE/PKG # e.g. cli/arg
Expand All @@ -41,7 +51,7 @@ bb_load MODULE/PKG # e.g. cli/arg
Alternatively, you can list modules and packages to load by argument when sourcing `bash-boost.sh`:

```bash
source /path/to/bash-boost.sh MODULE MODULE/PKG ...
source /path/to/bash-boost/latest/bash-boost.sh MODULE MODULE/PKG ...
```

If you want to distribute bash-boost as a single file, you can use `bash-boost-portable.sh` and all modules and packages will be available for use. Please use proper attribution if distributing bash-boost. See [LICENSE](LICENSE) for details.
Expand All @@ -50,6 +60,14 @@ If you want to distribute bash-boost as a single file, you can use `bash-boost-p
source /path/to/bash-boost-portable.sh
```

You may also want to add the included scripts and manpages to your path lists:

```bash
bb_load util/env # for bb_appendpathuniq
bb_appendpathuniq PATH "$BB_ROOT/bin"
bb_appendpathuniq MANPATH "$BB_ROOT/man"
```

## Organization

bash-boost consists of the following _modules_, each with different _packages_
Expand Down

0 comments on commit 532ac80

Please sign in to comment.