search

osvenskan / posix_ipc

Other
139 stars 25 forks source link

Convert doc to Markdown #29

Closed osvenskan closed 2 years ago

osvenskan commented 3 years ago

Summary

Currently my personal site is the primary repository for the documentation. Since it's formatted in HTML, it's less easy to read on GitHub than it could be. If the doc was in Markdown, it's be easier to change the project's organization to have GitHub be the primary source of both the doc and source code.

christopolise commented 2 years ago

I'd be willing to look into this if help is still wanted!

osvenskan commented 2 years ago

Hi @christopolise, thanks for the offer! I created a new branch for this work. I integrated the work from @GreatBahram from #31 and now I'd like to build on that. There are two tasks you could take on. One is to convert the usage instructions in ReadMe.html into markdown in usage.md. Another is to convert history.html to markdown. Any progress on these would be appreciated.

https://github.com/osvenskan/posix_ipc/tree/29-convert-doc-to-markdown

christopolise commented 2 years ago

Will do! I am assuming I should just fork the repo and then make a PR when I've made the changes?

osvenskan commented 2 years ago

Yep, that works for me, as long as I can merge to https://github.com/osvenskan/posix_ipc/tree/29-convert-doc-to-markdown. Thanks!

christopolise commented 2 years ago

Finished these edits and open up a PR #33 . Let me know if there is anything else that needs to be done!

osvenskan commented 2 years ago

resolved with the release of 1.1.0