lachtan/linux-workspace
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update project documentation

Browse Source
This commit is contained in:
lachtan
2026-03-15 20:35:30 +01:00
parent 7ad3fa729c
commit dd7a9249a2
2 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CLAUDE.md
View File

@@ -10,6 +10,7 @@ and adds `bin/` to PATH. `$LWS` points to repo root.
- `bin/` — Scripts auto-added to PATH. New CLI tools go here. - `bin/` — Scripts auto-added to PATH. New CLI tools go here.
- `scripts/` — Setup scripts NOT on PATH (git-config, docker fixes, gnome config). - `scripts/` — Setup scripts NOT on PATH (git-config, docker fixes, gnome config).
- `conf/` — Tool configs (vim, WireGuard, WSL). - `conf/` — Tool configs (vim, WireGuard, WSL).
- `doc/` — Reference docs, cheatsheets, bookmarks.
- `functions.sh` — Core lib (see below). - `functions.sh` — Core lib (see below).
## Key Helpers (`functions.sh`) ## Key Helpers (`functions.sh`)
@@ -26,7 +27,7 @@ and adds `bin/` to PATH. `$LWS` points to repo root.
## Conventions ## Conventions
All new bash scripts should use: All new **executable** bash scripts should use:
```bash ```bash
#!/usr/bin/env bash #!/usr/bin/env bash
@@ -34,8 +35,13 @@ All new bash scripts should use:
set -E -o errexit -o nounset -o pipefail set -E -o errexit -o nounset -o pipefail
``` ```
**Sourced files** (rc files, `functions.sh`) must NOT use `set -o errexit` — they run inside
the user's shell. Add `# shellcheck shell=bash` at the top instead of a shebang.
Before writing shell code, check `functions.sh` for existing helper functions and prefer them over raw commands. Before writing shell code, check `functions.sh` for existing helper functions and prefer them over raw commands.
Detailed formatting, naming, and syntax rules are in `.claude/rules/bash-style.md`.
RC files MUST guard slow tools and check availability: RC files MUST guard slow tools and check availability:
```bash ```bash

4
README.md
View File

@@ -24,6 +24,10 @@ For faster load can be set
For debug log enabled For debug log enabled
`LWS_DEBUG=1` `LWS_DEBUG=1`
## Directory notes
`opt/` (git-ignored) is used for locally installed tools (e.g. bash-git-prompt, enhancd).
## Quick commands ## Quick commands
```bash ```bash