search

Drutol / CrossHMI

Reactive HMI Android application example
2 stars 0 forks source link

Generate GitHub Pages #4

Closed mpostol closed 6 years ago

mpostol commented 6 years ago

Read more about GitHub Pages Basics.

GitHub Pages sites are publicly available on the internet, even if their repositories are private.

Therefore, GitHub Pages can be refere4nced by a link and available to the public community.

The content should follow the gist:

https://gist.github.com/mpostol/2d3f982ac548a272233956046625b2d6

Use your RAEDME.md and the project description: OOI Projects

Drutol commented 6 years ago

I've deployed basic static website to GitHub Pages.

https://drutol.github.io/ReactiveNetworking.CrossHMI/

mpostol commented 6 years ago

It looks like a personal page but is used like the project page. You can generate the page one per project using README.md and select template.

For me, it doesn't matter but there should be information on how to get in touch with the author.

"Related work" means project depending on my workout. Here the mentioned relationship is in opposite direction, but still, it could be there.

Drutol commented 6 years ago

Yeah I could do that but I found the default themes to be far less customizable so I went ahead and chose something more versatile. It will be easy to include some documentation there later if such need arises. It's made with https://www.mkdocs.org

True, I'll add separate page with contact info.

Oh, I understood it the other way round, it makes more sense now. In the future it could be viable to make little library out of it to serve as a layer of abstraction on top of your Library so defining the Models/ViewModels would be much simpler and streamlined.

Drutol commented 6 years ago

I've updated the page. Should be sufficient for current state of the project. Thanks for remarks.