search

holochain / holonix

Holochain app development environment based on Nix.
4 stars 1 forks source link

docs: add user instructions to readme #51

Closed jost-s closed 2 weeks ago

jost-s commented 3 weeks ago

closes #32

pdaoust commented 3 weeks ago

Any PR that adds documentation is a PR that makes me happy :) Just one question, and I don't want this question to block merging: who's the intended audience? I'm assuming it's all hApp devs, but the first section assumes familiarity with Nix terms. Maybe just some brief text that define what Nix and flakes are? (heck, I don't even know what a flake is; I know it's some sort of derivation file, maybe, and that's it)

jost-s commented 2 weeks ago

Looks good. Nice and informative. I just added some format suggestions, feel free to ignore them 🙂

Thanks @cdunster, very helpful and I didn't ignore them but included them. =)

jost-s commented 2 weeks ago

Any PR that adds documentation is a PR that makes me happy :) Just one question, and I don't want this question to block merging: who's the intended audience? I'm assuming it's all hApp devs, but the first section assumes familiarity with Nix terms. Maybe just some brief text that define what Nix and flakes are? (heck, I don't even know what a flake is; I know it's some sort of derivation file, maybe, and that's it)

The intended audience are happ devs that have some experience and want to perhaps tweak their flakes. The total beginners will have a scaffolded flake in the project folders. I added a link to the Holochain dev env setup at the top of the document.