Skip to content

Latest commit

 

History

History
136 lines (85 loc) · 4.07 KB

Template.md

File metadata and controls

136 lines (85 loc) · 4.07 KB
Raw

Template/Styleguide for NYSTHI Manpages

Intended for use in a monospace text editor such as Notepad++. If you need to copy/paste from the Github page, click the "Raw" button just above and to the right of this section of the page. That way you won't strip the Markdown formatting or add extra HTML crap.

If a *, #, or ` looks out of place to you, but you're not well-versed in Github-Flavoured Markdown syntax, just leave it be ;-)

—Pat

[Name of Module]

Author: [Your Name(s)] [Github handles are okay here, as are Proper Names and initials, e.g. John D., J. Doe]

Last Updated: YYYY/MM/DD

Last Patch: 0.6.33

INDEX (If you can't get this working on your own, just let Pat know. At least try to keep the general formatting.)

  1. Antonio Says
  2. Basics
  3. Functions by Section
  4. Usage
  5. Sample Patches

Antonio Says

Click to see the Changelog 
	0.6.33
COPY/PASTE THE RELEVANT PATCHNOTES FROM THE LATEST PARSED CHANGELOG BETWEEN THE TICK MARKS

	0.666.antonio.works.way.too.fast
If it looks wonky, try a
    nd clean up 
extra         spaces, 
------- tabs, and carriage returns.

Basics

![](./moduleimage.png) [saved in the same directory.]

Type: VCA / PB&J Sandwich / ABCDE [Don't worry if you don't get every last usage case.]

Size: X HP [If you don't like squinting, use aP-Modules HP Meter :-D ]

Modeled After/Inspired by: [If Antonio included references to hardware/software in the changelog, the module browser in Rack (like he did the Complex DAHD), or on a FB post, put those here. The same goes for requests from people for a module that does XYZ; put their name in here.]

Functions by Section

Section A

[The sections should be in reference to the image - see MetaAardvark for a great example.]

Try and describe what the control does, what voltage range a CV Input accepts, the kind of signal an output generates, etc. Usage has its own section, so please try and limit descriptions to specific controls here.

FUNCTION NAMES should be in ALL CAPS.

If you need to add a specification in a text block, try to be as clear as possible, e.g. "-666.00 V to +666.00 V (Default: 0.00 V) ". If you can't fit the phrase inline, separate it out like these:

Default Clock Rate: 10.00 Hz

Min Clock Rate: 0.01 Hz

(Anything between 3 *s will be in bold -and- italic)

Section B

If you need to write in point form:

  • Type [dash], [space], then type your first-level items.
    • [space] [space] [dash] [space] to start your second-level items.
  • Don't add extra lines between list items.

Start writing normally again (no extra dashes and spaces, an extra ) once you have finished writing your list.

Section C

Useful modules for testing:

  • Visualizing Signals

    • Fundamental Scope
    • Gratrix Scope-G1
    • Submarine Free EO-102 (Envelope Oscilloscope)
    • Submarine Free LA-108 (Logic Analyzer)
    • Bogaudio Analyzer-XL

  • Quantifying Signals/Knob Values

    • Computerscare Debug
    • alikins Hovered Value
    • alikins Specific Value

  • CV/Trigger Generation/Manipulation

    • Submarine Free SS-221 (21 Output Voltage Sources)
    • LOGinstruments Precise DC Gen
    • ML Modules Sum8
    • Impromptu Clocked
    • AS Flow

  • General

    • aP-Modules HP Meter

Section D

[As many sections as make sense. You're not required to use 4!]

Usage

Describe how to use the module.

Sample Patches

[typethefullpatchname.vcv] (./typethefullpatchname.vcv)

  • Save the patch in the same folder. Please don't link to external services, since they're not owned by Microsoft (like Github), and who knows if/when they'll go down?

If your patch isn't self-evident based on how you've described the module above, try and include some kind of basic write-up.