Skip to content

Commit

Permalink
Try to make README.md less misleading
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
JojOatXGME committed Apr 29, 2024
1 parent 6bb218f commit a1d99e3
Showing 1 changed file with 26 additions and 23 deletions.
49 changes: 26 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,20 @@

<!-- Plugin description -->

This plugin has the goal of being generally useful when working with nixpkgs/NixOS/nixops, it aims
to provide the following:

* Syntax Highlighting
* Linting
* Profile management
* Suggestions for:
* Attributes
* Builtins
* Filesystem paths
* Templates for common usage patterns
This plugin has the goal of being generally useful when working with nixpkgs/NixOS/nixops.
It currently adds support for the Nix language.
The following features are available:

* Syntax Highlighting
* Real time detection of syntax errors

We would also like to provide additional support for Nix/NixOS/NixOps,
but the following features are currently **not implemented**:

* Linting, code completion, formatting
* Profile management
* Run configurations
* Templates for common usage patterns

<!-- Plugin description end -->

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

* Goto **File > Settings > Plugins > Marketplace**
* Type **NixIDEA** into the search bar
* Click **Install**
* Goto **File > Settings > Plugins > Marketplace**
* Type **NixIDEA** into the search bar
* Click **Install**

### From ZIP file

You can also install the plugin from a ZIP file.

* Goto **File > Settings > Plugins**
* Click onto the **wheel icon** on the top
* Choose **Install Plugin from Disk**
* Goto **File > Settings > Plugins**
* Click onto the **wheel icon** on the top
* Choose **Install Plugin from Disk**

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

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

* Clone the repository
* Ensure that you have a JDK for Java 11 or higher on your PATH
* Only on NixOS: Setup JetBrains Runtime (JBR) from `<nixpkgs>`
```sh
nix-build '<nixpkgs>' -A jetbrains.jdk -o jbr
```
* Clone the repository
* Ensure that you have a JDK for Java 11 or higher on your PATH
* Only on NixOS: Setup JetBrains Runtime (JBR) from `<nixpkgs>`
```sh
nix-build '<nixpkgs>' -A jetbrains.jdk -o jbr
```

### Build execution

Expand Down

0 comments on commit a1d99e3

Please sign in to comment.