<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Thu, Jun 20, 2013 at 7:08 PM, Daniel van Vugt <span dir="ltr"><<a href="mailto:daniel.van.vugt@canonical.com" target="_blank">daniel.van.vugt@canonical.com</a>></span> wrote:<br> <blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Just some notes to consider before anyone tries to write docs:<div class="im"><br> <br> * How to write a a Mir backend for a window manager / toolkit. This could really help other projects that are interested in supporting Mir.<br></div> - Backend for a "window manager": This means a shell, linking to libmirserver. I may be alone in thinking this, but am not comfortable we have our class structure (via libmirserver) quite right to go documenting this yet. But still, you can look at examples/demo-shell/*<br> which some might find surprising to hear is intended to be a totally generic shell with no links to Unity. It still needs more functionality yet, though.<br></blockquote><div><br></div><div>Makes sense, but in the interim, having this information and pointing to examples/demo-shell would likely help. Any idea when we the class structure may be more stabilized?<br> </div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"> - Toolkit: This means a client linking to libmirclient. The client API is *almost* completely stable now. Changes are minimal these days so it's safe to document, and the basics are documented:<br> <a href="http://unity.ubuntu.com/mir/group__mir__toolkit.html" target="_blank">http://unity.ubuntu.com/mir/<u></u>group__mir__toolkit.html</a><div class="im"><br></div></blockquote><div><br></div><div>So this looks API documentation, which is useful, but I was thinking it would be more useful to have a short tutorial or walkthrough the steps of how to create a client. Is this something someone would be willing to volunteer to write and link on the Mir wikisite? <br> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im"> <br> * How to build Mir for non-Ubuntu systems. Jef Spaleta shared this concern with me this week, and I think some more generic build instructions would be useful.<br></div> - I totally agree we need to make building everything-Mir easier, for everyone. We have had discussions and will work on easing the process. I think it could be documented now but that documentation will of course evolve with the projects themselves.<div class="im"> <br></div></blockquote><div><br></div><div>Makes sense. Maybe this documentation will be better served as a wiki page.<br><br>Jef, if the team would be happy to work on this, would you be happy to help document building Mir for Fedora? <br> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im"> <br> * How to write a driver that supports Mir. This could be of interest for a hardware company who is interested in exploring Mir support for their hardware.<br></div> - This can not be documented until we have at least had a first attempt at making it possible to load external code:<br> <a href="https://bugs.launchpad.net/mir/+bug/1118909" target="_blank">https://bugs.launchpad.net/<u></u>mir/+bug/1118909</a><br> <br></blockquote><div><br></div><div>When Alan fixes this bug and we are in a position to do this, would be happy to have a crack at writing something here?<br><br>Thanks, Daniel! <br></div><div><br></div><div> Jono<br> </div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"> - Daniel<div class="im"><br> <br> <br> On 21/06/13 06:55, Jono Bacon wrote:<br> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im"> Hi,<br> <br> Some time ago I asked Daniel Holbach to coordinate with the Mir team to<br> improve the documentation on <a href="http://wiki.ubuntu.com/Mir" target="_blank">wiki.ubuntu.com/Mir</a><br></div> <<a href="http://wiki.ubuntu.com/Mir" target="_blank">http://wiki.ubuntu.com/Mir</a>> to make it simple to participate in Mir<div class="im"><br> development. I think Daniel and the team did a great job there.<br> <br> There are now some other documentation needs that I think we need in<br> light of recent discussions:<br> <br> * How to write a a Mir backend for a window manager / toolkit. This<br> could really help other projects that are interested in supporting Mir.<br> <br> * How to build Mir for non-Ubuntu systems. Jef Spaleta shared this<br> concern with me this week, and I think some more generic build<br> instructions would be useful.<br> <br> * How to write a driver that supports Mir. This could be of interest<br> for a hardware company who is interested in exploring Mir support for<br> their hardware.<br> <br> I have Daniel to take care of working with our community and Mir<br> engineers to put together these docs. Is anyone willing to help<br> contribute to putting this content together as part of this effort?<br> <br> Thanks!<br> <br> Jono<br> <br> --<br> Jono Bacon<br> Ubuntu Community Manager<br> </div><a href="http://www.ubuntu.com" target="_blank">www.ubuntu.com</a> <<a href="http://www.ubuntu.com" target="_blank">http://www.ubuntu.com</a>> / <a href="http://www.jonobacon.org" target="_blank">www.jonobacon.org</a><br> <<a href="http://www.jonobacon.org" target="_blank">http://www.jonobacon.org</a>><br> <a href="http://www.identi.ca/jonobacon" target="_blank">www.identi.ca/jonobacon</a> <<a href="http://www.identi.ca/jonobacon" target="_blank">http://www.identi.ca/<u></u>jonobacon</a>><br> <a href="http://www.twitter.com/jonobacon" target="_blank">www.twitter.com/jonobacon</a> <<a href="http://www.twitter.com/jonobacon" target="_blank">http://www.twitter.com/<u></u>jonobacon</a>><br> <br> <br> </blockquote><div class="HOEnZb"><div class="h5"> <br> -- <br> Mir-devel mailing list<br> <a href="mailto:Mir-devel@lists.ubuntu.com" target="_blank">Mir-devel@lists.ubuntu.com</a><br> Modify settings or unsubscribe at: <a href="https://lists.ubuntu.com/mailman/listinfo/mir-devel" target="_blank">https://lists.ubuntu.com/<u></u>mailman/listinfo/mir-devel</a><br> </div></div></blockquote></div><br><br clear="all"><br>-- <br>Jono Bacon<br>Ubuntu Community Manager<br><a href="http://www.ubuntu.com">www.ubuntu.com</a> / <a href="http://www.jonobacon.org">www.jonobacon.org</a><br><a href="http://www.identi.ca/jonobacon">www.identi.ca/jonobacon</a> <a href="http://www.twitter.com/jonobacon">www.twitter.com/jonobacon</a> </div></div>