.. _manual-main: ======== CiteLang ======== .. image:: https://img.shields.io/github/stars/vsoch/citelang?style=social :alt: GitHub stars :target: https://github.com/vsoch/citelang/stargazers .. image:: https://raw.githubusercontent.com/vsoch/citelang/main/docs/assets/img/pypi-citelang.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 2. Give credit accounting for dependencies! 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. .. _main-support: ------- Support ------- * For **bugs and feature requests**, please use the `issue tracker `_. * For **contributions**, visit us on `Github `_. --------- Resources --------- `GitHub Repository `_ The code on GitHub. .. toctree:: :caption: Getting started :name: getting_started :hidden: :maxdepth: 3 getting_started/index getting_started/user-guide getting_started/settings .. toctree:: :caption: API Reference :name: api-reference :hidden: :maxdepth: 1 api_reference/citelang api_reference/internal/modules