Hi Phil, I think that your idea is very interesting and useful! Even if I have some experience in C++ (none in Qt), I have also difficulties to figure out the Hydrogen code. All the things you mentioned could be very helpful for people (like me) who think they can write the code but find the overall structure either too complicated or too time consuming to understand. For example a flowchart which explains the basic structure and connections could be helpful. Also a quick guide about the developing tools, such as how to open the project in Qt and how to run it. Perhaps it is obvious to experienced users but at least for me it wasn't. Cheers, Kimmo
On touko 8 2019, at 10:53 pm, Philipp Müller via Hydrogen-devel <hydrogen-devel@lists.sourceforge.net> wrote: > > Hey Thijs, > You are right. The average user does not care about things like `pEngine`. > But those who want to start contributing do IMHO have quite some overhead > when reading the code. I personally did not had any experience in C++ or Qt > and it took me quite a while to figure out how things are working within > Hydrogen. If we could come up with some "developer introduction" shortly > summarizing things like the overall design of H2, the separation of the GUI > and the core + how they do communicate with each other, some basics about the > sampler and sound generation, instrument and drumkit design and last but not > least the general working of the audio engine with e.g. > `audioEngine_process()` and the role of the audio driver things would be much > more beginners friendly. Future contributors could give it e.g. a 20 minute > read and jump right into the feature/bug they want to tackle. And some > general hints how to debug the software would probably also quite handy. > I plan to write such an introduction at some point in the future. But this > will take some time since I still just understand about 60%-70% of the things > H2 is doing. Some of this might be already present in the wiki but having it > not scattered through various pages but condensed into one document would be > nice. This could be a separate one or an "advanced" section in the user > manual (but the former would be probably nicer). > Regarding the shipping of the manual: Up to now I was not even aware of it > and always used the online one. Since it is served with the homepage linked > on top of the Github page, it is quite easy to find and probably most users > do access it this way. Or do you have a different workflow/experience? > Cheers, > Phil > On 5/7/19 8:12 AM, Thijs van severen wrote: > > > > Hi Phil, thanks for the feedback! > > > > Are you talking about the user manual or about the coding documentation? > > > > I'm talking about the user manual. Things like pEngine dont belong there > > IMHO. Or am i missing something here? > > > > Some way to auto-push the content of the git repo to the website would > > indeed be handy. I remember that (a looong time ago) we were thinking about > > ways to generate a pdf version of the manual so that this pdf could then be > > bundled with H2 as separate document. > > IIRC the manual is now part of the H2 application so a usr cannot update it > > to the latest version without upgrading the complete application. > > > > Maybe we could even include an automatic 'check for updated manual' when H2 > > starts and if an updated manual is available (for the H2 version that the > > user is running!!) the user can be notified and given the option to > > download this new version > > > > Grtz > > Thijs > > > > > > Op ma 6 mei 2019 09:43 schreef Philipp Müller via Hydrogen-devel > > <hydrogen-devel@lists.sourceforge.net > > (mailto:hydrogen-devel@lists.sourceforge.net)>: > > > Hey Thijs, > > > > > > On 06.05.19 08:32, Thijs van severen wrote: > > > > > > > > I'm thinking about possibly considering to maybe get started on > > > > updating the manual ;-) > > > +1 > > > > Before i dive in : is the howto doc on the site up to date? Anything > > > > else i need to know ? > > > > > > I think it would be a good idea to use some continuous integration to > > > automatically push updates of the documentation to the website. > > > > > > I'm not quite sure how it is served right now but since there is already > > > a dedicated [git repo](https://github.com/hydrogen-music/hydrogen-music) > > > and the website is static, we could use Github Pages. > > > This way we could simply include the repo of the documentation as a > > > submodule and use the latest version. I'm not a 100% sure if one can > > > trigger Travis to process one repo (web page) when pushing to another > > > (doc) but there's probably a hook for that. > > > > > > What I really want to do is to get the naming of the Hydrogen and > > > AudioEngine straight and consistent and possibly also reflect it in the > > > docs. The former is often called pEngine in the code and it led to quite > > > some confusion at my end when first delving into the code. But this > > > deserves another thread and I will post a message during next days. > > > > > > Cheers, > > > Phil > > > > > > > > > _______________________________________________ > > > Hydrogen-devel mailing list > > > Hydrogen-devel@lists.sourceforge.net > > > (mailto:Hydrogen-devel@lists.sourceforge.net) > > > https://lists.sourceforge.net/lists/listinfo/hydrogen-devel > > > > > > > > > > _______________________________________________ > Hydrogen-devel mailing list > Hydrogen-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/hydrogen-devel >
_______________________________________________ Hydrogen-devel mailing list Hydrogen-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/hydrogen-devel
