socratools / socranop

Soundcraft Notepad mixer tools for Linux
MIT License
8 stars 2 forks source link

Use consistent short tagline, description, summary text #88

Open ndim opened 7 months ago

ndim commented 7 months ago

At many places, a short one line description of a software package is used, or a longer brief multiline description, or a many line description.

It would be nice if we could up with a really short and precise text for these purposes, and reuse that as often as possible.

It might be possible add a constant to socranop.constants with the short one-liner, and use that at least in *.desktop, *.metainfo.xml, "About socranop" comments, setup.py.

Existing texts for the one-liners are

ndim commented 7 months ago

The one-liner should contain

A word like "utilities" or "tool" is not very helpful when minimizing word count.

"For Linux" makes sense in metadata on pypi, on GitHub, in a textual description on a homepage, etc, but not in a short tagline either.

"Set audio routing to Soundcraft Notepad series mixer USB capture device channels" is still too long.

ndim commented 7 months ago

Collecting all one liners as of right now:

ndim commented 7 months ago
0         1         2         3         4         5         6         7
0----v----0----v----0----v----0----v----0----v----0----v----0----v----0
Set audio routing to Soundcraft Notepad series mixer USB capture device channels
Control Soundcraft Notepad mixer audio routing to USB capture
Route Soundcraft Notepad mixer audio channels to USB capture channels
Control audio routing of Soundcraft Notepad series mixers
Control Soundcraft Notepad series mixer audio routing
Control Soundcraft Notepad series mixer audio routing to USB

Or we could go more generic in anticipation of ducker feature support:

0         1         2         3         4         5         6         7
0----v----0----v----0----v----0----v----0----v----0----v----0----v----0
Control some Soundcraft Notepad mixer functions
Control some functions of Soundcraft Notepad mixers
Control some functions of Soundcraft Notepad series mixers
Control functions of Soundcraft Notepad series mixers
Control Soundcraft Notepad series mixers