Skip to content

Commit a1d99e3

Browse files
committed
Try to make README.md less misleading
The README.md listed multiple features which are currently not implemented. While the README.md didn't claim that these features are currently implemented, people reading the description might interpret it that way. The new description is hopefully more clear about what is currently implemented.
1 parent 6bb218f commit a1d99e3

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

README.md

+26-23
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,20 @@
55

66
<!-- Plugin description -->
77

8-
This plugin has the goal of being generally useful when working with nixpkgs/NixOS/nixops, it aims
9-
to provide the following:
10-
11-
* Syntax Highlighting
12-
* Linting
13-
* Profile management
14-
* Suggestions for:
15-
* Attributes
16-
* Builtins
17-
* Filesystem paths
18-
* Templates for common usage patterns
8+
This plugin has the goal of being generally useful when working with nixpkgs/NixOS/nixops.
9+
It currently adds support for the Nix language.
10+
The following features are available:
11+
12+
* Syntax Highlighting
13+
* Real time detection of syntax errors
14+
15+
We would also like to provide additional support for Nix/NixOS/NixOps,
16+
but the following features are currently **not implemented**:
17+
18+
* Linting, code completion, formatting
19+
* Profile management
20+
* Run configurations
21+
* Templates for common usage patterns
1922

2023
<!-- Plugin description end -->
2124

@@ -26,17 +29,17 @@ to provide the following:
2629
The plugin can be found at the Jetbrains plugin repository as
2730
[NixIDEA][marketplace].
2831

29-
* Goto **File > Settings > Plugins > Marketplace**
30-
* Type **NixIDEA** into the search bar
31-
* Click **Install**
32+
* Goto **File > Settings > Plugins > Marketplace**
33+
* Type **NixIDEA** into the search bar
34+
* Click **Install**
3235

3336
### From ZIP file
3437

3538
You can also install the plugin from a ZIP file.
3639

37-
* Goto **File > Settings > Plugins**
38-
* Click onto the **wheel icon** on the top
39-
* Choose **Install Plugin from Disk**
40+
* Goto **File > Settings > Plugins**
41+
* Click onto the **wheel icon** on the top
42+
* Choose **Install Plugin from Disk**
4043

4144
You can find corresponding ZIP files [on GitHub][releases] or build them
4245
yourself as described below.
@@ -47,12 +50,12 @@ yourself as described below.
4750

4851
Follow the following steps before you build the project the first time.
4952

50-
* Clone the repository
51-
* Ensure that you have a JDK for Java 11 or higher on your PATH
52-
* Only on NixOS: Setup JetBrains Runtime (JBR) from `<nixpkgs>`
53-
```sh
54-
nix-build '<nixpkgs>' -A jetbrains.jdk -o jbr
55-
```
53+
* Clone the repository
54+
* Ensure that you have a JDK for Java 11 or higher on your PATH
55+
* Only on NixOS: Setup JetBrains Runtime (JBR) from `<nixpkgs>`
56+
```sh
57+
nix-build '<nixpkgs>' -A jetbrains.jdk -o jbr
58+
```
5659

5760
### Build execution
5861

0 commit comments

Comments
 (0)