README: Add installation and integration docs #243
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 tasks
dasJ
force-pushed
the
feat/install-instructions
branch
from
0887200
to
44b3e27
Compare
infinisil
approved these changes
Aug 29, 2024
README.md
Outdated
| ### treefmt | ||
|
|
||
| [treefmt](https://github.com/numtide/treefmt) can be used to format repositories consisting of different languages with one command. | ||
| A possible configuration for `nixfmt` in `.treefmt.toml` looks like this: |
There was a problem hiding this comment.
Suggested change
| A possible configuration for `nixfmt` in `.treefmt.toml` looks like this: | |
| A possible configuration for `nixfmt` in `treefmt.toml` looks like this: |
README.md
Outdated
Comment on lines
21
to
23
| `nixfmt` was used as the basis for the official Nix formatter with a standardized formatting. | ||
| The new formatting differs considerably from the original one. | ||
| This is why two packages are in nixpkgs: `nixfmt-classic` with the non-standardized formatting and `nixfmt-rfc-style`. |
There was a problem hiding this comment.
Suggested change
| `nixfmt` was used as the basis for the official Nix formatter with a standardized formatting. | |
| The new formatting differs considerably from the original one. | |
| This is why two packages are in nixpkgs: `nixfmt-classic` with the non-standardized formatting and `nixfmt-rfc-style`. | |
| A recent nixfmt version is available as `pkgs.nixfmt-rfc-style` in Nixpkgs. The formatting of this version differs considerably from the original nixfmt that was used as the basis for the standardised official formatter, which is also still available as `pkgs.nixfmt-classic` for now, though unmaintained. |
Just a rewording to make the distinction clearer
README.md
Outdated
| ### From the repository | ||
|
|
||
| It's also possible to install `nixfmt` directly from the repository using `nix-env`. | ||
| This allows the newest changes to be used, which may not be equal to the `nixfmt` version used to format nixpkgs, so this should be done with care! |
There was a problem hiding this comment.
This applies to all methods here. I think there should be an additional section referring to how the nix-shell in Nixpkgs provides the correct version for Nixpkgs. Alternatively, let's just drop this sentence, otherwise it implies the above would be the correct version. As an upstream project we shouldn't really have to document downstream uses.
Suggested change
| This allows the newest changes to be used, which may not be equal to the `nixfmt` version used to format nixpkgs, so this should be done with care! |
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| More information about configuration can be found in [the official README](https://github.com/numtide/treefmt-nix?tab=readme-ov-file#integration-into-nix). |
There was a problem hiding this comment.
Suggested change
| More information about configuration can be found in [the official README](https://github.com/numtide/treefmt-nix?tab=readme-ov-file#integration-into-nix). | |
| More information about configuration can be found in [the README](https://github.com/numtide/treefmt-nix?tab=readme-ov-file#integration-into-nix). |
Just a minor precaution, we don't want people to think that treefmt is also an official Nix project.
README.md
Outdated
Comment on lines
48
to
56
| ``` | ||
| { | ||
| outputs = { nixpkgs, self }: { | ||
| formatter.x86_64-linux = nixpkgs.legacyPackages.x86_64-linux.nixfmt-rfc-style; | ||
| }; | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| ``` | |
| { | |
| outputs = { nixpkgs, self }: { | |
| formatter.x86_64-linux = nixpkgs.legacyPackages.x86_64-linux.nixfmt-rfc-style; | |
| }; | |
| } | |
| ``` | |
| ```nix | |
| { | |
| outputs = | |
| { nixpkgs, self }: | |
| { | |
| formatter.x86_64-linux = nixpkgs.legacyPackages.x86_64-linux.nixfmt-rfc-style; | |
| }; | |
| } | |
| ``` |
We should adhere to our own formatting :P
dasJ
force-pushed
the
feat/install-instructions
branch
from
3c967d0
to
19b8be8
Compare
7 tasks
dasJ
force-pushed
the
feat/install-instructions
branch
2 times, most recently
from
0f4cbcf
to
e4033f6
Compare
dasJ
force-pushed
the
feat/install-instructions
branch
from
469aa5b
to
3d18524
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.