Skip to content

Commit ffecfb9

Browse files
readme: tidy up wording
1 parent 5349f0c commit ffecfb9

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
1-
# Practicalli Astro Configuration
1+
# Practicalli Astro5 Neovim Configuration
2+
3+
```none
4+
██████╗ ██████╗ █████╗ ██████╗████████╗██╗ ██████╗ █████╗ ██╗ ██╗ ██╗
5+
██╔══██╗██╔══██╗██╔══██╗██╔════╝╚══██╔══╝██║██╔════╝██╔══██╗██║ ██║ ██║
6+
██████╔╝██████╔╝███████║██║ ██║ ██║██║ ███████║██║ ██║ ██║
7+
██╔═══╝ ██╔══██╗██╔══██║██║ ██║ ██║██║ ██╔══██║██║ ██║ ██║
8+
██║ ██║ ██║██║ ██║╚██████╗ ██║ ██║╚██████╗██║ ██║███████╗███████╗██║
9+
╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚══════╝╚═╝
10+
11+
█████╗ ███████╗████████╗██████╗ ██████╗ ███████╗
12+
██╔══██╗██╔════╝╚══██╔══╝██╔══██╗██╔═══██╗ ██╔════╝
13+
███████║███████╗ ██║ ██████╔╝██║ ██║ ███████╗
14+
██╔══██║╚════██║ ██║ ██╔══██╗██║ ██║ ╚════██║
15+
██║ ██║███████║ ██║ ██║ ██║╚██████╔╝ ███████║
16+
╚═╝ ╚═╝╚══════╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚══════╝
17+
```
18+
19+
> NOTE: Ascii Art Generator: https://patorjk.com/software/taag/#p=display&f=ANSI%20Shadow&t=Astro%205
20+
221

3-
A rich and resource efficient configuration for [Neovim 0.11.x](https://neovim.org/) providing common development tooling, including an effective Clojure REPL workflow
22+
## Overview
23+
24+
A lazy loading rich feature configuration for [Neovim 0.11.x](https://neovim.org/), providing common development tooling, including an effective Clojure REPL workflow.
425

526
This configuration is built upon [AstroNvim version 5](https://github.com/AstroNvim/AstroNvim), extending the AstroNvim v5 template with valuable plugins, options and key mappings.
627

728
[Practicalli Neovim](https://practical.li/neovim/) describes the Clojure REPL workflow, rich Git and GitHub clients and easy management of plugins and tools using this configuration.
829

9-
> NOTE: updates to Practicalli Neovim will focus on Practicalli nvim-astro5 from April 2025 onward.
1030

1131
## 🛠️ Installation
1232

@@ -16,7 +36,7 @@ Recommended tools:
1636
- [Neovim and supporting tools](https://practical.li/neovim/install/neovim/)
1737
- [Clojure CLI](https://practical.li/clojure/install/)
1838

19-
Clone the Practicalli Astro repository (create a fork if customisation desired)
39+
Clone the Practicalli Astro5 repository (create a fork if customisation desired)
2040

2141
```shell
2242
git clone git@github.com:practicalli/nvim-astro5 $HOME/.config/nvim
@@ -59,14 +79,15 @@ astro5
5979

6080
The configuration is based on the AstroNvim v5 template config. Changes to existing file have been kept to a minimum, except for `lua/community.lua` which has additional plugins from the AstroNvim Community repository.
6181

62-
`lua/plugins/user-practicalli.lua` contains Practicalli specific configuration (plugins, preferences & key maps). This also provides an example of how to modify and extend the AstroNvim configuration yourself.
82+
`lua/plugins/practicalli.lua` contains Practicalli specific configuration (plugins, preferences & key maps). This also provides an example of how to modify and extend the AstroNvim configuration yourself.
83+
84+
Set environment variable `PRACTICALLI_ASTRO` to false to skip the Practicalli config without requiring a code change.
6385

6486
Create your own `lua/plugins/user-yourname.lua` file to:
6587

6688
- override default plugin configuration
67-
- add new plugins (or create a new file for a plugin to make them easier to be optional) or by customising the `lua/plugins/user.lua` file.
89+
- add new plugins (or create a new file for a plugin to make them easier to be optional)
6890

69-
Set environment variable `PRACTICALLI_ASTRO5` to false to skip the Practicalli config without requiring a code change.
7091

7192
[Practicalli Astro5 config design](https://practical.li/neovim/reference/astro5-configuration/) provides a complete breakdown of this configuration.
7293

@@ -75,7 +96,7 @@ Set environment variable `PRACTICALLI_ASTRO5` to false to skip the Practicalli c
7596

7697
### LSP Servers
7798

78-
An LSP server implementation is required for each language, allowing the Neovim LSP client to obtain diagnostic information.
99+
Install an LSP server for each programming language used, allowing the Neovim LSP client to obtain diagnostic information.
79100

80101
Mason is used to automatically install LSP servers, format & lint tools. [Mason Registry](https://mason-registry.dev/registry/list) maintains a list of the latest release for each tool (automatically updated).
81102

0 commit comments

Comments
 (0)