Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update headline / Add key differences section
Browse files Browse the repository at this point in the history
sestrella committed Nov 21, 2023
1 parent 38e7776 commit 77ccbb7
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -13,7 +13,8 @@ features:
- **Transition to Nix** - asdf2nix is intended to be used as a bridge tool for
asdf users who want to try Nix without investing heavily in setting up a
completely new development environment with Nix.
- **Friendly error messages** - TODO
- **Friendly error messages** - The majority of error messages contain hints on
how to work around them in order to improve the development experience.

## Disclaimer

@@ -22,7 +23,18 @@ plugins](https://github.com/asdf-vm/asdf-plugins) that asdf2nix does not; while
some workarounds are detailed in the following sections, some of them require a
deeper understanding of Nix.

TODO: Talk about major differences with asdf
### Key Differences

- **Up-to-date versions** - Unlike asdf plugins, asdf2nix plugins do not obtain
the list of versions directly from an official upstream; thus, the available
packages may be slightly out-of-date when compared to their counterpart
plugins.
- **Plugins repository** - In contrast to asdf, there is no central repository
containing all references to existing plugins; users may have to rely on
GitHub or a Nix flake registry to locate specific plugins.
- **Reproducibility** - Because Nix values reproducibility, alias versions of
the form `x.y` or `x` may not be supported by all plugins due to their
mutability.

## Getting Started

@@ -127,6 +139,8 @@ functions:
For more information on how to structure a plugin, see the [Python
plugin](plugins/python).

TODO: Workaround for missing plugins

## License

[MIT](LICENSE)

0 comments on commit 77ccbb7

Please sign in to comment.