Make the repo a bit cleaner by subdividing things in folders, so adding some more referenced docs outside readme

[sjaehn]

|examples
| | myAmp...
|docs
| | License-options.md
| |_ Build-systems-cmake-makefile-meson.md
| |_ UI-adding-resources.md
| |_ ...
|README.md
| ...

Issued by @redtide

[redtide]

About this: I'm currently trying to port my sites from jekyll (ruby and liquid, IIRC originally made by and for GitHub) to mkdocs (python and jinja2); these are static website generators.
The latter is simple to setup and at the minimum requires only a yaml file in the root dir. I'll make a test site as demo.
This way the files can be read in the repo and also on a site.

[redtide]

in repo: https://github.com/redtide/lv2tutorial/tree/mkdocs/docs
the site demo: https://redtide.github.io/lv2tutorial/

EDIT: just noticed now that the license on my fork is still gpl3 though the fork is up to date with the upstream master and ahead of 1 commit, how is it possible??

[sjaehn]

Thanks for your work. Please make a pull request. Then I can merge it.

[redtide]

it's more a draft because it's a very big change, I think should be discussed:
I splitted the readme in several documents to display as website pages, that means that the readme should be re-made to have references to those files, otherwise we should maintain 2 versions of the docs

[sjaehn]

It's not a big thing (my POV). README.md as an entry point. With an index linking to the respective *.md files in the ./docs folder. This makes sense as the tutorial gets bigger and bigger.
I can do the changes as well (or at least the index - let me know), but you already did the most of the work.

[redtide]

if you are OK with it then I can handle the readme as well, not much things there, I have also some other (tiny) additions for it. I think i'll do the PR tomorrow

[redtide]

I have the thing ready, I only miss a cmake file for the bwidgets example.
Before proceeding I need to talk to you about the CI build for the site and some rules needed to make the job straightforward. Email? (I'm redtid3 at gmail dot com), IRC? (lad channel to say one)

[redtide]

OK, so now it's missing the examples directory where to move the plugins, with a related cmake files reorganization, so I will take the chance to add also the missing cmake files for the latest plugins. If it's OK I'll do it this weekend.

[redtide]

before doing anything, could be moving the plugins in a "examples" dir being confusing for users after seeing videos?

[sjaehn]

I also thought about this issue. And yes, it could be confusing for the viewers if they can't directly find the source code folders (as in the videos). On one hand it should be doable for the viewers to find the content inside an "examples" or "src" folder. But on the other hand there's no need to add such a stumbling block.

My POV: It's better to keep the source code file locations. And I think clean enough as all source code folders start with "my". (Notable exception: LV2Stub. This one can also be renamed to "templates" or whatever (as I don't think that I had mentioned this folder in one of my videos (?)). And I should take hands on its content.)