https://github.com/vshn/package-appcat

https://github.com/vshn/package-appcat

vshn-project-appcat vshn-project-ignore

Last synced: 28 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/vshn/package-appcat
• Owner: vshn
• License: bsd-3-clause
• Created: 2023-09-29T11:47:30.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-04T11:13:11.000Z (about 1 year ago)
• Last Synced: 2023-12-29T12:38:14.623Z (12 months ago)
• Topics: vshn-project-appcat, vshn-project-ignore
• Language: Makefile
• Homepage:
• Size: 19.5 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Commodore Package: appcat

This is a [Commodore][commodore] config package for appcat.

This repository is part of Project Syn.

For documentation on Project Syn and this component, see https://syn.tools.

## Documentation

Documentation for this package is written using [Asciidoc][asciidoc] and [Antora][antora].

It is located in the [docs/](docs) folder.

The [Divio documentation structure](https://documentation.divio.com/) is used to organize its content.

Run the `make docs-serve` command in the root of the project, and then browse to http://localhost:2020 to see a preview of the current state of the documentation.

After writing the documentation, please use the `make docs-vale` command and correct any warnings raised by the tool.

## Contributing and license

This library is licensed under [BSD-3-Clause](LICENSE).

For information about how to contribute see [CONTRIBUTING](CONTRIBUTING.md).

[commodore]: https://syn.tools/commodore/

[asciidoc]: https://asciidoctor.org/

[antora]: https://antora.org/