search

DUNE-DAQ / trigemu

Trigger decision emulator for January 2020 readout application tests
0 stars 0 forks source link

Put existing package documentation into `docs/` #27

Closed jcfreeman2 closed 3 years ago

jcfreeman2 commented 3 years ago

As described in this morning's talk, Toward Official DUNE DAQ Software Documentation, as well as at https://dune-daq-sw.readthedocs.io/en/latest/editing_package_documentation/, in a couple of weeks when dunedaq-v2.4.1 is released there should be comprehensive documentation about this package available for users. A good first step on this path - timescale O(1 week) - is to do the following:

  1. If one doesn't already exist, create a docs/ subdirectory in your repo
  2. If a README.md is in the base of your repo, move it into docs/
  3. Copy any pages on your repo's GitHub Wiki into docs/; the easiest way to do this is described in https://dune-daq-sw.readthedocs.io/en/latest/editing_package_documentation/
  4. Notify me when you're done and I'll add your changes to the DUNE DAQ software website, https://dune-daq-sw.readthedocs.io/en/latest