Proper Documentation

[Wegi]

Is it planned to start a documentation for this projects? If yes, what is the desired form? I might prepare a pull-request or some other form of help if it is clear whether any kind of documentation is wished for.

[jstepien]

Thanks for opening the discussion, @Wegi. Currently, any sort of documentation is clearly missing and I'd love to fill this gap. I don't have any clear vision on what would be the best way to structure it. For now I'd roughly divide it as follows:

• a README.md with brief getting started instructions and an overview of lein mutate command line interface, and
• doc/*.md files with in-depth discussion of internals as well as a guide for contributors.

Your contributions would be more than welcome! Don't worry about documentation's structure and other details; we can always rearrange it later. Let me know if there's any way I could help you to prepare your first PR.

[jstepien]

Hey @Wegi, I just pushed 10e2c89 dividing the documentation into two pieces. I hope that this answers questions you posed in the first comment. If so, feel free to close this issue, and in any other case please let me know. Contributions to the documentation are more then welcome. I'll work on it myself, time and other obligations permitting. Cheers! ✨

[Wegi]

Thats awesome, I'll try to produce some content in the coming days. :) Thanks again for this awesome tool.