-
-
Notifications
You must be signed in to change notification settings - Fork 361
Redo README.md #1308
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Redo README.md #1308
Conversation
Provide most relevant information about features/installation/development
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking pretty good!
README.md
Outdated
$ ./dev-shell | ||
### Installing | ||
|
||
_NixOps_ is included in nixpkgs and can be installed from your respective channel: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We might should warn that this repo contains NixOps 2.0 and the channels don't package it yet?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, yes indeed I should add something to that effect indeed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So I added a Note below, let me know if that's OK for you.
README.md
Outdated
_NixOps_ is included in nixpkgs and can be installed from your respective channel: | ||
|
||
``` | ||
$ nix-env -i nixops |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
$ nix-env -i nixops | |
$ nix-shell -p nixops |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm totally fine with changing this to nix-shell
but then the description shouldn't be saying "installing" right? Then it should say something about "trying it in a shell" right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Use it in a shell" maybe? I've never installed nixops :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, let's stick to nix-shell
for here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alrighty, i changed the text above..
Co-Authored-By: Graham Christensen <graham@grahamc.com>
Thanks! |
This is an attempt at providing a more helpful
README.md
which provides:This should address most of #1304