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

The README is not readable anymore #129

Open
polaroi8d opened this issue Apr 25, 2018 · 4 comments

Comments

2 participants
@polaroi8d
Copy link
Contributor

commented Apr 25, 2018

GitHub issue state GitHub issue title GitHub issue author GitHub issue label GitHub issue comments GitHub issue age GitHub issue last update

---------------------------- DO NOT DELETE OR EDIT anything above this line ----------------------------

There are plenty of texts in the READ.ME, I think we can slice this text into a docs folder. Where it could be API documentation, Getting started description, pull request policy or anything else, and on the main READ.ME file there is only a few information about the project and the lib. Any suggestion?

@Marzogh Marzogh self-assigned this Apr 25, 2018

@Marzogh

This comment has been minimized.

Copy link
Owner

commented Apr 25, 2018

Hi mate, you are right. I've just finished getting the wiki up to date and was thinking of reducing the ReadMe to just basics and point to the wiki for the next release.

I have also been looking at trying to get the repo Doxygen compatible so everything stays up to date with in-line code comments. However I have not used doxygen previously and so it might take me a little time to figure out how it works. 🙂

Also, I've recently discovered https://readthedocs.org/ and might will migrate the docs there someday.

@Marzogh Marzogh added this to To do in Operation Documentation via automation Apr 25, 2018

@Marzogh

This comment has been minimized.

Copy link
Owner

commented Apr 26, 2018

Started the process of getting documentation in order through Sphinx and ReadTheDocs - as of commit 51512a3

@Marzogh Marzogh moved this from To do to In progress in Operation Documentation Apr 26, 2018

@polaroi8d

This comment has been minimized.

Copy link
Contributor Author

commented Apr 26, 2018

Nice work! If you can shift any of these tasks I can help you in my freetime.

@Marzogh

This comment has been minimized.

Copy link
Owner

commented May 21, 2018

Thanks for the offer 👍 I've got whatever I have done to date on the development branch. Feel free to add to that if you have time and send in a pull request. 🙂

Just make sure you follow the same page format/design that I've already established - if you have ideas for improving that, feel free to let me know. I'm happy to take any suggestions for improvement on board. 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.