Skip to content

Commit 4e4d974

Browse files
install: refine section wording and format
1 parent 79cf5a5 commit 4e4d974

2 files changed

Lines changed: 16 additions & 25 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
## Changed
2424
- mkdocs: emoji extension name update for Material 9.4
2525
- project: update built.tools approach and configuration examples
26+
- install: refine section wording and format
2627

2728
# 2023-08-14
2829

docs/install/index.md

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,34 @@
11
# Install Clojure
22

3-
Clojure CLI is the minimum Clojure environment, although a [Clojure aware editor](/clojure/clojure-editors/) with [Clojure LSP server](/clojure/clojure-editors/clojure-lsp/) is highly recommended.
4-
5-
Clojure CLI provide the foundation for Clojure development, providing a declarative approach to:
3+
[Clojure CLI](clojure-cli.md) provides the foundation for Clojure development, providing a declarative approach to:
64

75
* Run Clojure programs and tools
86
* Run a REPL process (Read-Eval-Print Loop) and provides a basic interactive terminal UI
97
* Manage packaged dependencies from Maven (jars) and use Git repositories as dependencies
108

11-
[Practicalli Clojure CLI config](clojure-cli/#practicalli-clojure-cli-config) provides a user configuration that extends Clojure CLI with tasks to create, develop, build and deploy Clojure applications and services. Configuration for cljstyle Clojure format tool is also included.
12-
13-
[Clojure aware editors](/clojure/clojure-editors/) provide the most effective way to write and maintain Clojure projects, connecting to (or even starting) a Clojure REPL and evaluating code as its typed and seeing the results instantly in line with the code.
9+
!!! INFO "Practicalli Clojure Config community tools"
10+
[:fontawesome-solid-book-open: Practicalli Clojure CLI Config](clojure-cli/#practicalli-clojure-cli-config) is a user configuration providing aliases for a wide range of community tools which extends the features of Clojure CLI. The aliases include tools to create, develop, build and deploy Clojure code. Aliases are used heavily in the Practicalli books.
1411

15-
[Practicalli Clojure LSP configuration](/clojure/clojure-editors/clojure-lsp/) for static code analysis with Clojure LSP server and live code formatting with cljfmt.
12+
If the Practicalli Clojure CLI config is not used, review the [:fontawesome-brands-github: `deps.edn` file](https://github.com/practicalli/clojure-deps-edn/blob/live/deps.edn){target=_blank} from the GitHub repository and add relevant aliases definitions to your own Clojure CLI configuration.
1613

14+
## "Pre-requisites"
15+
16+
A [Java Virtual Machine](java.md) hosts Clojure. Java 21 is the current Long Term Support version providing a stable platform to run Clojure
1717

18-
## Complete Clojure environment
1918

20-
Establish an effective Clojure development environment by installing the following:
19+
## Additional tools
2120

22-
| Fundamental Tools | Purpose |
23-
|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
24-
| [Java 17 LTS](java.md) | Java virtual machine hosts Clojure. Java 17 is the current Long Term Support version providing a stable platform to run Clojure |
25-
| [Clojure CLI](clojure-cli.md) | Run Clojure REPL and other tools for development and production |
26-
| [Practicalli Clojure CLI config](clojure-cli/#practicalli-clojure-cli-config) | Curated aliases providing common development tasks and tools across all projects (used heavily in this guide) |
21+
!!! INFO "Clojure connected editor"
22+
A [Clojure connected editor](/clojure/clojure-editors/) provides the most effective way to write and maintain Clojure projects. The editor connects to (or starts) a Clojure REPL and code can be evaluated as its typed, showing the results instantly in line with the code.
2723

24+
[Clojure LSP server](/clojure/clojure-editors/clojure-lsp/) generates static analysis of code which editors can surface as code diagnostics. Analysis supports effective code navigate and refactor tools. [:fontawesome-solid-book-open: Practicalli Clojure LSP config](/clojure/clojure-editors/clojure-lsp/) configures
2825

29-
| Recommended Tools | Purpose |
30-
|-------------------------------------------------------------|------------------------------------------------------------------------------------------|
31-
| [Clojure aware editors](/clojure/clojure-editors/) | Editors providing a complete Clojure development environment |
32-
| [Clojure LSP server](/clojure/clojure-editors/clojure-lsp/) | Lint tool to detect syntax bugs and suggest idiomatic code |
33-
| [Data inspectors](/clojure/data-inspectors/) | Visualize results of Clojure code, navigate nested data and page through large data sets |
26+
!!! INFO "Data Inspectors"
27+
[Data inspectors](/clojure/data-inspectors/) visualize results of Clojure code evaluation and allow navigation of nested data or paging through large data sets.
3428

35-
!!! HINT "Aliases in Practicalli Clojure provided by Practicalli Clojure CLI config"
36-
[:fontawesome-solid-book-open: Practicalli Clojure CLI Config](clojure-cli/#practicalli-clojure-cli-config) provides a user configuration of over 50 aliases to support Clojure development. These aliases are used heavily in the Practicalli Clojure book.
29+
[Portal](/clojure/data-inspector/portal/) is highly recommended data inspector and included in projects generated with [Practicalli Project Templates](/clojure/clojure-cli/projects/templates/practicalli/).
3730

38-
If the Practicalli Clojure CLI config is not used, review the [`deps.edn` file](https://github.com/practicalli/clojure-deps-edn/blob/live/deps.edn){target=_blank} from the GitHub repository and add relevant aliases definitions to your own Clojure CLI configuration.
39-
40-
??? INFO "optional: clj-kondo static analysis tool"
41-
[Code analysis (clj-kondo)](/clojure/reference/code-analysis.md){target=_blank} is a Clojure syntax analysis tool that can detect syntax bugs and suggest idiomatic code. clj-kondo is included in clojure-lsp, so only recommended if clojure-lsp is not available.
4231

4332
??? INFO "Alternative development tools"
4433
[Leiningen](https://leiningen.org){target=_blank} is the long-standing development tool for Clojure. All the code examples in this book should work with Leiningen when a correctly configured `project.clj` file is created which includes all the necessary library dependencies. Libraries included via aliases should be added as either `:dev-dependencies` or `:aliases` in the Leiningen `project.clj` file.
34+

0 commit comments

Comments
 (0)