Skip to content

Commit

Permalink
Add zsh and fish helper script instructions (#410)
Browse files Browse the repository at this point in the history
Co-authored-by: Tracey Clark <[email protected]>
  • Loading branch information
TraceyC77 and Tracey Clark authored Oct 24, 2023
1 parent c9a1cce commit 57c0ca5
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions docs/packaging/prepare-for-packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,16 +99,34 @@ This makes it easy to create commits in the correct format, and will warn you ab

## Set up Monorepo Helper Functions (Optional)

After cloning your repo, create a symlink to source our bash shell helper functions
After cloning your repo, create a symlink to source our helper functions for your shell. Then, start a new instance of the shell.

### bash

```bash
mkdir -p ~/.bashrc.d
ln -s ~/solus-packages/common/Scripts/helpers.sh ~/.bashrc.d/solus-monorepo-helpers.sh
```

Then start a new instance of `bash` to source the script.
### fish

```fish
mkdir -p ~/.config/fish/conf.d
ln -s ~/solus-builds/packages/common/Scripts/helpers.fish ~/.config/fish/conf.d/solus.fish
```

### zsh

```zsh
mkdir -p ~/.zshrc.d
printf "\nfpath=(~/.zshrc.d \$fpath)" >> ~/.zshrc
source ~/.zshrc
ln -s ~/solus-builds/packages/common/Scripts/helpers.zsh ~/.zshrc.d/solus-monorepo-helpers.zsh
```

---

Afterwards, you should have the following available from your shell:
You should now have the following available from your shell:

| Function | Description | Usage |
| ----------------- | -------------------------------------------------------------------------------------------------- | ---------- |
Expand Down

0 comments on commit 57c0ca5

Please sign in to comment.