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

README.rst: add nix docs #6606

Merged
merged 1 commit into from
Jan 19, 2025
Merged

README.rst: add nix docs #6606

merged 1 commit into from
Jan 19, 2025

Conversation

DontEatOreo
Copy link
Contributor

No description provided.

@DontEatOreo
Copy link
Contributor Author

@mikf, sorry for the ping. I was just wondering if you could take a look?

README.rst Outdated Show resolved Hide resolved
@mikf
Copy link
Owner

mikf commented Jan 19, 2025

In general, I think this is a bit too long as a "quick" README guide, but the Docker section is equally long so I guess this is fine for now, but I wouldn't mind if you could remove 1 or 2 not so important parts.

In the future, (more) detailed installation instructions should probably go in a separate docs/installation.md document or the wiki and be kept to a minimum in the README itself, but that's not here nor now.

@DontEatOreo DontEatOreo force-pushed the add-nix-docs branch 2 times, most recently from 5b20692 to b15283c Compare January 19, 2025 15:49
@DontEatOreo
Copy link
Contributor Author

I decided to remove the nix3-run and nix profile since I think those are less needed if we don't want the Nix section to be long

@mikf mikf merged commit 0f50dd1 into mikf:master Jan 19, 2025
10 checks passed
@DontEatOreo DontEatOreo deleted the add-nix-docs branch January 19, 2025 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants