aboutsummaryrefslogtreecommitdiff
path: root/project_spec.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--project_spec.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/project_spec.md b/project_spec.md
index b2da1d4..e5ff7cf 100644
--- a/project_spec.md
+++ b/project_spec.md
@@ -6,7 +6,7 @@ and professional deployment workflows.
---
-## Todo
+## To-do
- [ ] Command-line arguments parser
- [ ] Handlers
- [ ] Reverse handler
@@ -14,7 +14,7 @@ and professional deployment workflows.
- [x] Version handler
- [ ] Help handler
- [ ] Default handler
- - [ ] 'strcmp' function
+ - [ ] `strcmp` function
- [ ] **Discuss exit codes**
@@ -37,21 +37,21 @@ and professional deployment workflows.
- [ ] **Packaging / Deployment**
> [!NOTE]
- > Build distributable tarballs (`.tar.gz`)
+ > Build target for distributed tarballs (`.tar.gz`)
> Arch Linux package (`makepkg`)
---
## Scope
### Product Specification
- - Providep a **CLI sorting tool** capble of reading from files and stdin.
+ - Provide a **CLI sorting tool** capable of reading from files and `stdin`.
- Support **multiple sorting modes** via flags:
- Ascending (default)
- Descending (`-r` or `--reverse`)
- Numeric
- Implement in **x86_64 Linux assembly**.
- - Include automated **CI/CD testing, benchmarking and packaging**
+ - Include automated **`CI/CD` testing, benchmarking, and packaging**
---