Skip to content
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

Merged
merged 6 commits into from Apr 20, 2020
Merged

Redo README.md #1308

merged 6 commits into from Apr 20, 2020

Conversation

gilligan
Copy link
Contributor

This is an attempt at providing a more helpful README.md which provides:

  • CI status info
  • key features
  • where to find more info
  • how to install
  • how to develop
  • how to contribute
  • LICENSE

This should address most of #1304

Provide most relevant information about
features/installation/development
Copy link
Member

@grahamc grahamc left a 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:
Copy link
Member

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?

Copy link
Contributor Author

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.

Copy link
Contributor Author

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ nix-env -i nixops
$ nix-shell -p nixops

Copy link
Contributor Author

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?

Copy link
Member

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 :)

Copy link
Member

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.

Copy link
Contributor Author

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..

README.md Outdated Show resolved Hide resolved
@grahamc grahamc merged commit f660466 into NixOS:master Apr 20, 2020
@grahamc
Copy link
Member

grahamc commented Apr 20, 2020

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants