No description

Find a file

Pieter Hijma 63c3230950 Merge pull request 'Quicklisp' (#4 ) Reviewed-on: #4		2023-06-23 15:41:44 +00:00
.reuse	Fix a problem with REUSE	2023-06-23 11:28:08 +02:00
LICENSES	Initialize the osh-autodoc-base repository	2022-12-09 14:39:05 +01:00
src	Move the .asd file to the root	2023-06-23 11:37:36 +02:00
osh-autodoc-base.asd	Move the .asd file to the root	2023-06-23 11:37:36 +02:00
README.md	Improve the README	2023-06-23 11:33:31 +02:00

README.md

Automated Documentation for Open Source Hardware - Base

Introduction

Within this project, we parse a Scribble file with a specification of an assembly manual and create an abstract syntax tree to be further processed by for example a PDF or HTML generator. Common functionality for the ASTs should be in this project, while backend-specific AST transformations should be in their respective projects.

Installation

Clone this repository and load the system via the osh-autodoc-base.asd file.

License

Most of the project is licensed under AGPL 3.0 or later. See the LICENSES folder and the SPDX metadata for more details. The project is REUSE compliant.

Authors

Pieter Hijma
J.C. Mariscal-Melgar

These authors contributed equally. For contacting the authors, please consult the REUSE metadata.

Issues

For reporting issues and bugs, please use the issue tracker on the OSH Automated Documentation Organization on Codeberg.org.

Funding

This project has been funded by the European Regional Development Fund (ERDF) in the context of the INTERFACER Project from October 2021 until March 2023.