Git Product home page Git Product logo

documentation's Introduction

Hydrogen website repository

This repository holds the website of the Hydrogen project.

The website can be reached via https://hydrogen-music.github.io/hydrogen-music/.

If you want to edit the documentation part of the website, please create a pull request at our Documentation repository. Do not edit the generated html of the manual/tutorial directly!

Deployment

You can use the provided Dockerfile to build and serve this slightly antique Jekyll page.

docker build -t hydrogen-music .
docker run --rm -p 4000:4000 hydrogen-music

documentation's People

Contributors

cme avatar cominu avatar jeremyz avatar luzpaz avatar mauser avatar oddtime avatar rwhogg avatar snan avatar thegreatwhiteshark avatar thijz avatar trebmuh avatar wolkstein avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentation's Issues

Please document copyright holder[s] and license

Please document copyright holders in this git repository. It is also necessary to document the license for these files to be redistributed. Next, a full-text copy of that license will most likely need to be included in the repository (depends on the license).

Finally, it would be nice to see a beta1 tag!

Kind regards,
Nicholas

Update the manual for hihat group

Hihat pressure groups enable users using v-drums to have different instruments depending on the pressure on the hihat pedal.

The hihat groups itself is for v-drum with different trigger for the hihat (edge, rim, etc.) so that a completely different group of different instruments can be setup per hihat trigger.

The manual needs to be updated to reflect all these functionalities.

1.2.3 Updates

  • add note about behavior of custom note lengths in the presence of tempo changes
  • update image showing stop note
  • review stop note parts of the doc -> maybe start Pattern Editor section with introduction of all different types of notes that can be used (regular, custom length, stop note)
  • in section for custom note length -> info that Instrument Editor > Release controls the length of the fade out
  • better ADSR coverage. (Release only applied on custom note lengths, maybe a figure highlighting changes in the
    sample)
  • Add Changelog
  • Add pictures of tutorial to shotlist -> 1.3.0
  • Rework tutorial -> 1.3.0
  • Update CMake setup to allow creating artifacts within build pipelines
  • Add new workflow to README.md

Restructure OSC command section

We already have quite a number of commands/endpoints (and I intend to add even more). Right now they are just presented as a bulk with no structure at all. How about grouping them into different topics?

In addition, most of the commands require an argument of a specific type. I would suggest to put the commands into tables with the rows: command itself | expected type | short explanantion

tagging documentation "releases" in sync with the main project

i assume that the documentation is moving in sync with the releases of hydrogen itself.

so: would it be possible to create a tag in the documentation repository, whenever you tag a release in the main repo as well (ideally: using the same name)?

this is related to: hydrogen-music/hydrogen#926

distributions like Debian really enforce using source code of everything (obviously binaries; but also documentation if it is generated from some abstract representation like docbook) during the packaging process.
while i appreciate your efforts in creating a separate tarball in the main repository (apart from the github-autogenerated one) that also contains the documentation.
however, as @trebmuh pointed out, it lacks the sources for the documentation.

so: in order to comply with a Debian packaging rules, we (the Debian packagers) need a way to get the source of everything to build a complete package from scratch. (you might think that this is anal; but really it's just the prize we pay for creating a free (as in speech) distribution)

i think that if you created matching tags here in the documentation repository, we would be able to come up with something that pulls in the sources for all artifacts (binary and docs) while importing a new upstream release. in an automated way ;-)

Note property setting for a given note in a chord

screenshot-0576f7b3

Is there a way of changing the velocity of the green note?
I am able to change only the velocity of the red one.
A solution is to select and move the green note in a temporary different position, change velocity and then moving to the initial position, but it's a bit long.
If one could select the desired note and then change its velocity in the bottom panel...

Updating translations

I just realize we do not support updating translation files *.po yet. There is only the manual.pot file generated from the current manual.docbook and the README.md states this should be copied to a manual_*.po and translated afterwards. But there is no way to update the latter.

The xml2pot package provides a program called split2po with which one could write a custom script. But the gettext system is so old there are full fledged solution in the official repos for sure. I'll have a look.

Translations of the manual

Right now, http://hydrogen-music.org/doc/ lists a couple of translations of the manual that are desperately out of sync. By scrolling through them it seems none of them reaches 30% translated content.

With the reworked version of the manual this percentage will decrease drastically. So, I think we have no choice but to drop them. But we should to still point out that translations of the manuals are both supported and highly welcome.

NSM doc

add a dedicated section about the peculiaries of the NSM support/usage.

Which documentation is still current and should be installed?

Hello,

I've finally found some time to work on the Debian package as well as to add the new documentation. What I've found is that "manual_en.html tutorial_en.html tutorial_fr.html tutorial_it.html" are new, but nothing else appears to be built from the source of this repository.

Should tutorial_*.html still be installed to /usr/share/hydrogen/data/new_tutorial ?
Should manual_en.html still be installed to /usr/share/hydrogen/data/doc ?
Should the other html files that aren't built from localised source just be ignored and/or removed at this time?

Finally, is there any reason why the clean target doesn't remove the generated html files?

Thank again!
Nicholas

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.