Skip to content

Commit 646ffe9

Browse files
authored
Refine README content and section headings
Updated project description and section titles for clarity.
1 parent d492a57 commit 646ffe9

1 file changed

Lines changed: 3 additions & 8 deletions

File tree

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
[![Hackage](https://img.shields.io/hackage/v/monk.svg?logo=haskell)](https://hackage.haskell.org/package/monk)
66
[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
77

8-
**Monk** is a sophisticated Haskell tool that translates Bash shell scripts into [Fish shell](https://fishshell.com/) scripts, helping you modernize your shell scripting workflow with Fish's more intuitive syntax and powerful features.
8+
**Monk** is a Haskell tool that translates Bash shell scripts into [Fish shell](https://fishshell.com/) scripts, helping you modernize your shell scripting workflow with Fish's more intuitive syntax and powerful features.
99

10-
## 🎯 Why Monk?
10+
## 🎯 Why Fish and Monk?
1111

1212
Fish shell offers many advantages over Bash:
1313
- **Intuitive syntax** - No more `$((arithmetic))` or `[[ conditions ]]`
@@ -154,7 +154,7 @@ end
154154

155155
## 🏗️ Architecture
156156

157-
Monk uses a sophisticated multi-stage translation pipeline:
157+
Monk uses a multi-stage translation pipeline:
158158

159159
```
160160
Bash Script → ShellCheck AST → Fish AST → Fish Script
@@ -192,7 +192,6 @@ cabal bench
192192
## Docs
193193

194194
- `docs/design/translator-todo.md`: translation semantics notes and open items
195-
- `docs/babelfish-comparison.md`: bake-off methodology and comparison notes
196195

197196
### Test Categories
198197

@@ -205,10 +204,6 @@ cabal bench
205204

206205
Monk covers most core Bash constructs and uses a semantic Fish IR to emit idiomatic Fish. The translator is conservative: it emits warnings and inline notes for constructs that need manual review and can fail fast in strict mode. We also hoist side-effecting expansions across arguments, redirections, and case patterns, and lower short-circuit arithmetic into conditional evaluation to preserve side effects. Recent additions include `read` flag mapping (`-n/-t/-u/-a`) with IFS splitting notes and best-effort `set -e`/`pipefail` emulation.
207206

208-
## 🤝 Comparison with Babelfish
209-
210-
See `docs/babelfish-comparison.md` for a focused, reproducible bake-off methodology and a structured comparison.
211-
212207
### Non-trivial Translations (Behavior Notes)
213208

214209
- **Arrays are 1-indexed**: Bash `arr[0]` becomes Fish `$arr[1]`.

0 commit comments

Comments
 (0)