agbeltran / citelang

markdown syntax and credit system for software (under development!)

Home Page:https://vsoch.github.io/citelang/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CiteLang

PyPI version

https://raw.githubusercontent.com/vsoch/citelang/main/docs/assets/img/citelang-tree.png

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 ⭐️

docs/assets/img/pypi-citelang.png

TODO

  • citelang should be able to parse go.sum, package.json, and R requirements file, others etc.
  • colors should be meaningful

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.

About

markdown syntax and credit system for software (under development!)

https://vsoch.github.io/citelang/

License:Mozilla Public License 2.0


Languages

Language:Python 89.3%Language:HTML 7.7%Language:Shell 2.8%Language:Dockerfile 0.3%