Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

An inquiry and request #18

Open
cwlowder opened this issue Dec 8, 2020 · 1 comment
Open

An inquiry and request #18

cwlowder opened this issue Dec 8, 2020 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@cwlowder
Copy link

cwlowder commented Dec 8, 2020

Hello good sir!

I am writing you, a total stranger, with an inquiry into your recently published repository moshpit. While the name is quite memorable and the code exquisite, I find myself disappointed that your readme inadequately describe the purpose of this menagerie of config files and script of java. Perhaps, if you might for the purpose of discoverability and easing the archeology of future generations, provide but a brief description or delineation for the work that you so tirelessly expressed in what can only be described as poetry, we may sleep better at night knowing we left the world a better place than we found it.

Thank you for your time and I look forward to reading more of your code soon.

Yours and always,

cwlowder

@lpulley lpulley self-assigned this Dec 8, 2020
@lpulley lpulley added the documentation Improvements or additions to documentation label Dec 8, 2020
@lpulley
Copy link
Owner

lpulley commented Dec 8, 2020

Hi! Long time no see! 😄

I think you're right. The README is a bit sparse. This was for a class project and finals are happening so I haven't been giving it the attention it deserves, but the README at the very least should be more detailed for archival's sake.

Thanks @cwlowder!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants