ALM MFX

[icco]

https://busycircuits.com/docs/alm032-manual.pdf

[pressdarling]

@icco Check out the contribution guidelines in the Readme:

The cheat sheets are written in HTML with some CSS for styling. If you want to contribute in that format, that is great. If you don't have the skills, formatted text or markdown in an issue is a great start.

Adding a module

Module documentation consists of an index XML file listing the pages with their icons and tags, and separate HTML files, one for each page of a cheat sheet.

To add a module:

Create a subdirectory for your module under the data/ directory
Create a "module.xml" file for your module. This describes what pages exist in the module's documentation. For example see Rings' module.xml. You can leave out the icon key if you don't have icons for your pages.
Add an entry for your module into data/modules.xml.
For each page in your module.xml, create a standalone HTML file. It's probably easiest to start by copying whatever existing page looks closest to your desired result.
Generally speaking, stick to no inline styles, no javascript. Use the existing styles for LEDs and knobs, add a second CSS file in your module directory for any new styles.

Please note, all contributions must be original work free from other copyright. Please do not copy & paste content unless you have explicit license or permission from the copyright holder.

Emphasis mine on the first and last lines.

If you want to take a pass at writing that up, someone else may be able to help you with reformatting it for a pull request for inclusion here. Otherwise, it would be best to check with ALM for permission if you want to reuse their content for this - they may be amenable, they may not be. If not, it would need to be rewritten.

[boourns]

I emailed ALM back in March 2021 asking for their permission to reproduce parts of manuals, and never received a response. I just sent them another email request and will post an update if they respond.

[boourns]

Response received, we have permission from Matthew Allum to reuse the text/copy only (no drawings, diagrams, fonts, logos, photos) from the manuals for the following modules:

ALM034 PPW, ALM022 Squid Salmple and ALM035 ASQ-1, ALM MFX.

He's asked for me to request permission for any others before adding them, which I'm happy to abide by.

If somebody can summarize the content in the PDF I am happy to get the module added and app released.