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

Document flake usage #10

Merged
merged 2 commits into from
Apr 10, 2024
Merged

Conversation

danieroux
Copy link
Contributor

@danieroux danieroux commented Mar 17, 2024

This PR does not affect any functionality. #11 builds on top of it, and does add new functionality.

It documents how to flake init the example, and then shows how to use that example.

It also explains how clojure-nix-locker and nix run .#locker has the same result.

@whentze
Copy link
Member

whentze commented Mar 22, 2024

Hey! Thanks a lot for the PR, this looks great.

I like the flake example, but I think we should still document the stable non-flake way as well.

Maybe the docs should just have two sections, one for flake users and one for plain Nix users?

… use the flake

- This shows how to control the classpath locations that `clojure` uses
- Make explicit that $HOME is read-only
@danieroux danieroux force-pushed the document-flake-usage branch from c600e12 to 8202b5c Compare April 9, 2024 21:50
@danieroux
Copy link
Contributor Author

@whentze I've updated the README to have both ways. Is this what you were looking for?

@whentze
Copy link
Member

whentze commented Apr 10, 2024

Looks very nice! I like the note about the read-only $HOME as well. Thank you, merging.

@whentze whentze merged commit f3b9505 into bevuta:master Apr 10, 2024
@danieroux danieroux deleted the document-flake-usage branch April 10, 2024 20:58
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.

2 participants