citelang 0.0.14

Credit parser and markdown language for scientific software.

CiteLang

Welcome to CiteLang! This is the first markdown syntax for citing software. Importantly, when you use CiteLang to reference software.

1. Generate basic software credit trees (citelang graph, badge, or credit)
2. Give credit accounting for dependencies! (see software-credit.md)
3. Actions (automation) for the above!

No - we aren't using DOIs! A manually crafted identifier that a human has to remember to generate, in addition to a publication or release, is too much work for people to reasonably do. As research software engineers we also want to move away from the traditional "be valued like an academic" model. We are getting software metadata and a reference to an identifier via a package manager. This means that when you publish your software, you should publish it to an appropriate package manager.

⭐️ Documentation ⭐️

TODO

• citelang should be able to parse requirements.txt or go.sum, etc.
• add graphic summary (need static version to go into markdown)
• colors should be meaningful
• finish GitHub actions (render, docs, remember to mention to use token, etc.)
• add gha to run here!

Contributors

We use the all-contributors tool to generate a contributors graphic below.

Vanessasaurus 💻

License

This code is licensed under the MPL 2.0 LICENSE.