You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Replace vague documentation with concrete information:
- Add "Deliverable" section defining what Modshells does
- Add "Current Status" summary showing working vs stub features
- Split "Development Status" into "Working Now" vs "Not Yet Implemented"
- Update "Usage" section to distinguish current functionality (v0.0)
from planned functionality (v0.1+)
- Improve directory structure descriptions
Co-authored-by: Claude <noreply@anthropic.com>
@@ -11,35 +11,58 @@ Written in Ada for safety-critical reliability.
11
11
12
12
toc::[]
13
13
14
-
== Overview
14
+
== Deliverable
15
15
16
-
Modshellstransforms monolithic shell configuration files (`.bashrc`, `.zshrc`, etc.) into a modulardirectory structure. Instead of maintaining a single, sprawling configuration file, Modshells organises configurations into logical categories that are automatically sourced.
16
+
**Modshells** is a command-line tool that transforms monolithic shell configuration files into a modular, maintainable directory structure. The tool:
17
17
18
-
=== The Problem
18
+
1. **Creates** a standardised directory hierarchy for shell configurations
19
+
2. **Detects** installed shells on your system (Bash, Zsh, Fish, Nushell, and 6 others)
20
+
3. **Injects** sourcing logic into shell configuration files (with backup)
21
+
4. **Ensures idempotency** - safe to run multiple times without side effects
19
22
20
-
Traditional shell configuration becomes unwieldy:
23
+
=== Current Status
21
24
22
-
* Single files grow to hundreds of lines
23
-
* Related configurations scattered throughout
24
-
* Difficult to share configurations across shells
25
-
* No clear separation of concerns
26
-
* Risky manual editing of critical dotfiles
25
+
[cols="1,1"]
26
+
|===
27
+
| Aspect | Status
28
+
29
+
| Directory creation | Working
30
+
| Shell detection | Stub (returns hardcoded list)
31
+
| Config backup | Not implemented
32
+
| Source injection | Not implemented
33
+
|===
27
34
28
-
=== The Solution
35
+
*This is alpha software.* The core architecture is complete, but the primary feature (modularising shell configs) is not yet functional. See <<Development Status>> for details.
29
36
30
-
Modshells creates a standardised modular structure:
37
+
=== What You Get
38
+
39
+
After running `modshells`, your shell configurations are organised into:
Each directory contains shell-agnostic or shell-specific configuration snippets that are automatically sourced in order.
51
+
Each shell's config file (`.bashrc`, `.zshrc`, etc.) sources these directories automatically. Add a new alias? Drop a file into `misc/`. OS-specific tweak? Put it in `os/`. Done.
52
+
53
+
== The Problem
54
+
55
+
Traditional shell configuration becomes unwieldy:
56
+
57
+
* Single files grow to hundreds of lines
58
+
* Related configurations scattered throughout
59
+
* Difficult to share configurations across shells
60
+
* No clear separation of concerns
61
+
* Risky manual editing of critical dotfiles
62
+
63
+
== The Solution
64
+
65
+
Modshells creates a standardised modular structure with shell-agnostic or shell-specific configuration snippets that are automatically sourced in order.
0 commit comments