search

Infinidoge / nix-minecraft

An attempt to better support Minecraft-related content for the Nix ecosystem
MIT License
172 stars 18 forks source link

Transfer documentation from module to README #59

Open Silverdev2482 opened 5 months ago

Silverdev2482 commented 5 months ago

I think this is mostly good but I'm not sure about the syntax of how I named options, I also wouldn't be suprised as if there are a few spelling errors. It still need proofreading by me too.

Silverdev2482 commented 5 months ago

Will servers.<name.files> Only place non existing files, or will it overwrite them? I would like to specify that in the README. Did a quick skim over and it looked fine but I missed some xml/html? tags that I don't think are necessary. also I should change that link to the new Minecraft wiki instead of the old one but it looks good to me.

Silverdev2482 commented 5 months ago

Looking at it I believe it will put the files into a .bak when modified, but will overwrite the previous.bak file, if I am wrong please correct me.

Silverdev2482 commented 4 months ago

All suggestions look good to me, I wasn't too sure on format/syntax so I went to what seems the most similar with the existing readme. Not sure if I feel like documenting the files option, as I don't have the best understanding of the nix language. If @Misterio77 feels like documenting that we should wait, or maybe a make separate issue and pr. Other than that this seems all good to merge.

Silverdev2482 commented 4 months ago

Should that issue be created and this merged? Or do we add that to this PR and wait for it to be documented?