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

Update README #744

Merged
merged 2 commits into from May 1, 2020
Merged

Update README #744

merged 2 commits into from May 1, 2020

Conversation

@gilligan
Copy link
Contributor

gilligan commented May 1, 2020

Revamp the whole text providing info on

  • installation / setup via nixos module
  • building via nix-build
  • development environment via nix-shell

Notes

It is really nice that hydra is nowadays pretty easy to get up and running. Even more reason to provide the little necessary information directly at the source as part of the GitHub README.

Ideally i would like to extend this with a sub-section under Installation that briefly explains how to create a minimal project and jobset. In which case we could really consider someone "up and running" with only very few steps and explanation required.

But i would like to get feedback on the PR in its current state first and see if can be merged.

Thanks.

Revamp the whole text providing info on

- installation / setup via nixos module
- building via nix-build
- development environment via nix-shell
README.md Outdated Show resolved Hide resolved
@grahamc
Copy link
Member

grahamc commented May 1, 2020

Seems like a good start! Maybe some good stuff could be had from https://www.notion.so/grahamc/Hydra-Hacking-a455cc6c9ec1489d9144ed12c19d61e4 ?

Co-authored-by: Graham Christensen <graham@grahamc.com>
@gilligan
Copy link
Contributor Author

gilligan commented May 1, 2020

@grahamc sure, i sort of wanted to start out small but and see what people think but i'm happy to integrate a section under development that incorporates your info because it is definitely very valuable for anyone who wants to do actual work on hydra!

@grahamc grahamc merged commit 4dcae31 into NixOS:master May 1, 2020
1 check passed
1 check passed
tests
Details
@grahamc
Copy link
Member

grahamc commented May 1, 2020

Thanks!

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

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.