From 8d579012e90052da33043fc72ff39c811431b233 Mon Sep 17 00:00:00 2001
From: Yannick DAYER <yannick.dayer@idiap.ch>
Date: Mon, 30 Oct 2023 12:34:52 +0100
Subject: [PATCH] meta(readme): switch to markdown and update infos.

---
 README.md  | 35 +++++++++++++++++++++++++++++++++++
 README.rst | 49 -------------------------------------------------
 2 files changed, 35 insertions(+), 49 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.rst

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..59db259
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Bob Nightlies
+
+This package is part of the signal-processing and machine learning toolbox
+[Bob](https://www.idiap.ch/software/bob). It implements the so-called
+"nightlies" aggregator. Its main CI pipeline is triggered every night so all
+packages are properly packaged against the latest environment and tested
+together under that light.
+
+## Updating a Package
+
+>>>
+:warning: Before adding a package to this prototype, please ensure that the
+package contains all standard components of a Bob_ package (README, unit
+tests, CI integration, documentation and conda build recipe among others).
+
+If you don't know how to do this, ask for information on our [mailing
+list](https://www.idiap.ch/software/bob/discuss).
+>>>
+
+The new package must be added to `.gitlab-ci.yml` respecting the order of
+dependencies.  Once the file is modified, commit the changes to a **new
+branch**, with a suggestive name. Push the branch and merge it to the master
+(or ask it to be merged), via a standard merge request.
+
+**You have to** add this package to the `bob/docs` repository as well.
+
+## Removing a Package
+
+Once you remove a package from `.gitlab-ci.yml`, make sure to remove it from
+the `bob/docs` repository as well.
+
+## Contact
+
+For questions or reporting issues to this software package, contact our
+development [mailing list](https://www.idiap.ch/software/bob/discuss).
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 996b529..0000000
--- a/README.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-.. vim: set fileencoding=utf-8 :
-.. Sat Feb 17 14:26:47 2018 CET
-
-===============
- Bob Nightlies
-===============
-
-This package is part of the signal-processing and machine learning toolbox
-Bob_. This package implements the so-called "nightlies" aggregator. Its build
-is triggered every night so all packages are properly recompiled against the
-latest environment and tested together under that light.
-
-
-Updating a Package
-------------------
-
-.. warning::
-
-   Before adding a package to this prototype, please ensure that the package
-   contains all standard components of a Bob_ package (README, unit tests, CI
-   integration, documentation and conda build recipe among others).
-
-   If you don't know how to do this, ask for information on our `mailing
-   list`_.
-
-The new package must be added to ``.gitlab-ci.yml`` respecting the order of
-dependencies.  Once the file is modified, commit the changes to a **new
-branch**, with a suggestive name. Push the branch and merge it to the master
-(or ask it to be merged), via a standard merge request.
-
-**You have to** add this package to ``bob/bob`` and ``bob/docs`` repositories as well.
-
-Removing a Package
-------------------
-
-Once you remove a package from ``.gitlab-ci.yml``, make sure to remove it from ``bob/bob``
-and ``bob/docs`` repositories as well.
-
-
-Contact
--------
-
-For questions or reporting issues to this software package, contact our
-development `mailing list`_.
-
-
-.. Place your references here:
-.. _bob: https://www.idiap.ch/software/bob
-.. _mailing list: https://www.idiap.ch/software/bob/discuss
-- 
GitLab