[IsaMc68k] A specification of distribution for a library of macros

[sporniket]

User story

As a developper

I want to have a normalized and automated way of adding a library of macros

In order to manage easily the dependencies of a project.

Technical details

Library consumer journey

• Getting a library : use a cli that gets a tarball containing meta data, and copy the library into libs_mac/<pack>/<age>/<path>/...
• Using a library : include <pack>/<age>/<path>/<library_name>.s
• Reading library reference manual (generated) : open libs_mac.doc/<pack>/<age>/<path>/<library_name>.s

Library developper journey

• Write sources inside libs_mac/<pack>/<age>/<path>/...
• Install developper dependencies like getting a library, but the files are added to an exclusion list.
• Write CI tests program into tests/suite_00 up to test/suite_99. A command line tool will help bootstrapping each suite.
• Write meta data (toml ? other format ?) to describe the packaging of the lib.
• Generate the package, publish somewhere

toolchain bootstrapping

• a python cli will be used (platform independance)
• Some essential libraries of macros available as packages to start

[sporniket]

Portable library description, inspired by PlatformIO library.json :

{
    "providers":{
        "supported":[
            "github",
            "gitlab",
            "platformio"
        ],
        "preferred":"github"
    },
    "names":[
        "github:sporniket/myLibrary",
        "gitlab:sporniket/myLibrary",
        "platformio:sporniket/myLibrary"
    ],
    "version":"0.0.3",
    "description":"C++ library for PlatformIO, an implementation to interface with the 7-segment controller TM1637, using an I2C link of the ESP32.",
    "keywords":"IIC, I2C, esp32, espressif32, espidf, tm1637, TM1637",
    "dependencies":{
        "sporniket/Tm1637-by-sporniket":{
            "version":"~0.0.3",
            "sources":[
                "github:sporniket/Tm1637-by-sporniket",
                "platformio:sporniket/Tm1637-by-sporniket"
            ]
        }
    },
    "repository":{
        "type":"git",
        "urls":[
            {
                "github":"https://github.com/sporniket/Tm1637Esp32",
                "gitlab":"https://github.com/sporniket/Tm1637Esp32"
            }
        ]
    },
    "authors":[
        {
            "name":"David SPORN",
            "url":"https://github.com/sporniket",
            "maintainer":true
        }
    ],
    "export":{
        "exclude":[
            ".gitignore",
            "*.gz"
        ]
    },
    "license":"GPL-3.0-or-later"
}