mirror of https://codeberg.org/glenneth/stash.git
docs: improve markdown formatting and readability
- Add blank lines before code blocks for better readability - Fix markdown URL formatting - Update .gitignore to exclude development notes
This commit is contained in:
parent
ca2c9ce010
commit
56fea692f3
|
|
@ -17,3 +17,6 @@ Thumbs.db
|
||||||
.\#*
|
.\#*
|
||||||
*.swp
|
*.swp
|
||||||
*.swo
|
*.swo
|
||||||
|
|
||||||
|
# Development notes
|
||||||
|
.dev-notes.md
|
||||||
|
|
|
||||||
|
|
@ -65,7 +65,9 @@ After installation, you might want to ensure the `stash` command is easily acces
|
||||||
- If not, create a symbolic link: `ln -sf ~/.guix-profile/bin/stash ~/.local/bin/stash`
|
- If not, create a symbolic link: `ln -sf ~/.guix-profile/bin/stash ~/.local/bin/stash`
|
||||||
|
|
||||||
2. **Using Manual Installation**:
|
2. **Using Manual Installation**:
|
||||||
|
|
||||||
- Add an alias to your shell config:
|
- Add an alias to your shell config:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# For Fish (in ~/.config/fish/config.fish):
|
# For Fish (in ~/.config/fish/config.fish):
|
||||||
alias stash="guile -L /path/to/stash /path/to/stash/stash.scm"
|
alias stash="guile -L /path/to/stash /path/to/stash/stash.scm"
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
# Stash User Guide
|
# Stash User Guide
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
1. [Installation](#installation)
|
1. [Installation](#installation)
|
||||||
- [Using Guix](#using-guix)
|
- [Using Guix](#using-guix)
|
||||||
- [Manual Installation](#manual-installation)
|
- [Manual Installation](#manual-installation)
|
||||||
|
|
@ -31,6 +32,7 @@ After installation, the `stash` executable will be available in your Guix profil
|
||||||
If you're not using Guix, you can install Stash manually:
|
If you're not using Guix, you can install Stash manually:
|
||||||
|
|
||||||
1. Install prerequisites:
|
1. Install prerequisites:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Debian/Ubuntu
|
# Debian/Ubuntu
|
||||||
sudo apt-get install guile-3.0
|
sudo apt-get install guile-3.0
|
||||||
|
|
@ -43,6 +45,7 @@ If you're not using Guix, you can install Stash manually:
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Clone and set up the repository:
|
2. Clone and set up the repository:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://github.com/yourusername/stash.git
|
git clone https://github.com/yourusername/stash.git
|
||||||
cd stash
|
cd stash
|
||||||
|
|
@ -55,6 +58,7 @@ If you're not using Guix, you can install Stash manually:
|
||||||
### Fish Shell
|
### Fish Shell
|
||||||
|
|
||||||
1. Add to `~/.config/fish/config.fish`:
|
1. Add to `~/.config/fish/config.fish`:
|
||||||
|
|
||||||
```fish
|
```fish
|
||||||
# Guix environment setup
|
# Guix environment setup
|
||||||
set -gx GUIX_PROFILE $HOME/.guix-profile
|
set -gx GUIX_PROFILE $HOME/.guix-profile
|
||||||
|
|
@ -70,6 +74,7 @@ If you're not using Guix, you can install Stash manually:
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Alternative method using symlink:
|
2. Alternative method using symlink:
|
||||||
|
|
||||||
```fish
|
```fish
|
||||||
ln -sf ~/.guix-profile/bin/stash ~/.local/bin/stash
|
ln -sf ~/.guix-profile/bin/stash ~/.local/bin/stash
|
||||||
```
|
```
|
||||||
|
|
@ -77,6 +82,7 @@ If you're not using Guix, you can install Stash manually:
|
||||||
### Bash Shell
|
### Bash Shell
|
||||||
|
|
||||||
Add to `~/.bashrc`:
|
Add to `~/.bashrc`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Guix environment setup
|
# Guix environment setup
|
||||||
export GUIX_PROFILE="$HOME/.guix-profile"
|
export GUIX_PROFILE="$HOME/.guix-profile"
|
||||||
|
|
@ -88,6 +94,7 @@ fi
|
||||||
### Zsh Shell
|
### Zsh Shell
|
||||||
|
|
||||||
Add to `~/.zshrc`:
|
Add to `~/.zshrc`:
|
||||||
|
|
||||||
```zsh
|
```zsh
|
||||||
# Guix environment setup
|
# Guix environment setup
|
||||||
export GUIX_PROFILE="$HOME/.guix-profile"
|
export GUIX_PROFILE="$HOME/.guix-profile"
|
||||||
|
|
@ -99,18 +106,21 @@ fi
|
||||||
## Basic Usage
|
## Basic Usage
|
||||||
|
|
||||||
1. Simple file stashing:
|
1. Simple file stashing:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Move a directory to backup location
|
# Move a directory to backup location
|
||||||
stash -s ~/Documents/notes -t ~/backup/notes
|
stash -s ~/Documents/notes -t ~/backup/notes
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Recursive stashing:
|
2. Recursive stashing:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Move entire config directory
|
# Move entire config directory
|
||||||
stash -s ~/.config -t ~/.dotfiles/config -r
|
stash -s ~/.config -t ~/.dotfiles/config -r
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Interactive mode:
|
3. Interactive mode:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Let stash prompt for target location
|
# Let stash prompt for target location
|
||||||
stash -s ~/Pictures -i
|
stash -s ~/Pictures -i
|
||||||
|
|
@ -119,15 +129,18 @@ fi
|
||||||
## Advanced Features
|
## Advanced Features
|
||||||
|
|
||||||
1. **Ignore Patterns**
|
1. **Ignore Patterns**
|
||||||
|
|
||||||
- Create `.stashignore` in source directory
|
- Create `.stashignore` in source directory
|
||||||
- Add patterns similar to `.gitignore`
|
- Add patterns similar to `.gitignore`
|
||||||
```
|
|
||||||
|
```sh
|
||||||
*.tmp
|
*.tmp
|
||||||
.DS_Store
|
.DS_Store
|
||||||
node_modules/
|
node_modules/
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Recursive Mode**
|
2. **Recursive Mode**
|
||||||
|
|
||||||
- Use `-r` flag for entire directory trees
|
- Use `-r` flag for entire directory trees
|
||||||
- Preserves directory structure
|
- Preserves directory structure
|
||||||
- Creates symlinks for all subdirectories
|
- Creates symlinks for all subdirectories
|
||||||
|
|
@ -170,4 +183,4 @@ fi
|
||||||
- "auto-compilation enabled": Set GUILE_AUTO_COMPILE=0
|
- "auto-compilation enabled": Set GUILE_AUTO_COMPILE=0
|
||||||
|
|
||||||
For more information or to report issues, visit:
|
For more information or to report issues, visit:
|
||||||
https://codeberg.org/glenneth/stash
|
<https://codeberg.org/glenneth/stash>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue