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

Better README.md #6

Open
superoo7 opened this issue Nov 8, 2018 · 5 comments
Open

Better README.md #6

superoo7 opened this issue Nov 8, 2018 · 5 comments

Comments

@superoo7
Copy link
Owner

superoo7 commented Nov 8, 2018

update README.md with current command, etc.

@princekelly1
Copy link

Hi,
I guess you need an updated readme for the project.
If so I can help create the document.

@superoo7
Copy link
Owner Author

superoo7 commented Nov 8, 2018

Current README.md is not updated with the latest command, etc. I was thinking about writing a proper document with document generator which splits into a few md file, that can be used by other code base also. e.g. COMMANDS.md, CONTRIBUTING.md, etc

@princekelly1
Copy link

princekelly1 commented Nov 8, 2018

Am not really familiar with document generator, which splits for other uses.
I think you want a readme file with contribution and command files in the readme?

@superoo7
Copy link
Owner Author

superoo7 commented Nov 8, 2018

I plan to do it myself, just using github issues to keep track of stuff and allow users to use this platform to file issues and bugs.

@princekelly1
Copy link

Ok

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants