Skip to content

Commit 6ec9a13

Browse files
dev: enhance project intro in readme
1 parent c2b0828 commit 6ec9a13

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,34 @@
99
╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚══════╝╚═╝
1010
```
1111

12-
[Practicalli books](https://practical.li/#books) use the configuration extensively to develop Clojure projects.
13-
1412
[Practicalli Clojure CLI Config](https://github.com/practicalli/clojure-cli-config/) contains a `deps.edn` alias definitions for a wide range of community libraries and tools to that extend the features of Clojure CLI.
1513

16-
The configuration also contains
14+
Aliases are qualified keywords using descriptive names to clearly convey purpose and provide a level of consistency to minimise cognitive load.
15+
16+
Common arguments are included in alias definitions via `main-opts` and `:exec-args` to provide a default behaviour and simplify the use aliases.
17+
18+
Alias used with the `-A`, `-M`, `-T` or `-X` execution options
19+
20+
Aliases are defined to be used with all execution options `-A`, `-M`, `-P`, `-T` or `-X` where possible, otherwise use the following execution options:
21+
22+
- `-M` for `:main-opts` configuration
23+
- `-X` for `:exec-opts` configuration
24+
- `-T` for `:exec-opts`, ignoring project dependencies
25+
26+
> [Clojure CLI - Which execution options to use](https://practical.li/clojure/clojure-cli/execution-options/)
27+
28+
The project also contains
1729

1830
* GitHub workflow that runs MegaLinter and Code Quality checks (clj-kondo and cljstyle via the setup-clojure action)
1931
* cljstyle configuration that follows the Clojure Style Guide
2032
* Rebel Readline example configuration (supports the Rich Terminal UI used by Practicalli)
2133
* cspell configuration for linting markdown and other text
22-
* `deps-deprecated.edn` containing alias examples of tools not used by Practialli, but may be of interest
34+
* `deps-deprecated.edn` containing alias examples of tools not currently used by Practialli which may still be of interest to the wider community
2335

36+
[Practicalli books](https://practical.li/#books) uses the Clojure CLI Config extensively to support a [REPL Reloaded workflow](https://practical.li/clojure/clojure-cli/repl-reloaded/) for Clojure projects.
2437

2538
[Practicalli Clojure book discusses Clojure CLI and its use](https://practical.li/clojure/clojure-cli/repl/), along with video walk-through of the key features.
2639

27-
Aliases use qualified descriptive names to avoid clashes with project specific aliases, ensuring that the user wide aliases remain available in all projects.
28-
29-
Common default arguments are included in an alias via `:exec-args` to minimise the cognitive load required to use aliases.
30-
31-
Aliases are used with the `-A`, `-M`, `-T` or `-X` execution options
32-
33-
> [Clojure CLI - Which execution options to use](https://practical.li/clojure/clojure-cli/execution-options/)
34-
3540

3641
[![License CC By SA 4.0](https://img.shields.io/badge/license-CC%20BY--SA%204.0%20-blueviolet)](http://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1)
3742
[![GitHub Sponsors for practicalli-john](https://img.shields.io/github/sponsors/practicalli-john)](https://github.com/sponsors/practicalli-john)

0 commit comments

Comments
 (0)