Skip to content

Commit

Permalink
Link to developer docs and contributor list from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
meliache committed Nov 6, 2023
1 parent 3aaf5d4 commit 14fabbf
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,22 @@ b2luigi
``b2luigi`` is a helper package constructed around ``luigi`` that helps you schedule working packages (so-called tasks)
locally or on a batch system.
Apart from the very powerful dependency management system by ``luigi``, ``b2luigi`` extends the user interface
and has a build-in support for the queue systems, e.g. LSF and HTCondor.
and has a built-in support for the queue systems, e.g. LSF and HTCondor.

You can find more information in the `documentation <https://b2luigi.readthedocs.io/en/stable/>`_.

Please note that most of the core features are handled by ``luigi``, so you might want to have a look into
the `luigi documentation <https://luigi.readthedocs.io/en/latest/>`_.
You can find more information in the `documentation <https://b2luigi.readthedocs.io/en/latest/>`_.
Please note that most of the core features are handled by ``luigi``, which is described in the
separate `luigi documentation <https://luigi.readthedocs.io/en/latest/>`_,
where you can find a lot of useful information.

If you find any bugs or want to add a feature or improve the documentation, please send me a pull request!
Check the `development documentation <https://b2luigi.readthedocs.io/en/latest/advanced/development.html>`_
on information how to contribute.

Contributors are listed `here <https://b2luigi.readthedocs.io/en/latest/index.html#the-team>`_.

This project is in still beta. Please be extra cautious when using in production mode.

To get notified about new features, (potentiall breaking) changes, bugs and
To get notified about new features, (potentially breaking) changes, bugs and
their fixes, I recommend using the ``Watch`` button on github to get
notifications for new releases and/or issues or to subscribe the `releases feed
<https://github.com/nils-braun/b2luigi/releases.atom>`_ (requires no github
Expand Down

0 comments on commit 14fabbf

Please sign in to comment.