From 9f05921f62a64f78fc6ebc20831cdd004a51778c Mon Sep 17 00:00:00 2001
From: Tobias Winchen <tobias.winchen@rwth-aachen.de>
Date: Fri, 20 Nov 2020 18:01:03 +0000
Subject: [PATCH] Added readme
---
.gitlab-ci.yml | 3 ---
README.md | 7 +++++++
doc/index.rst | 7 ++++++-
3 files changed, 13 insertions(+), 4 deletions(-)
create mode 100644 README.md
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index fc19ef43..fcb5911b 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -36,9 +36,6 @@ run_tests:
script:
- cd build
- make CTEST_OUTPUT_ON_FAILURE=1 test
- only:
- - pushes
- - merge_requests
make_doc:
stage: test
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..96a43462
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# psrdada-cpp
+
+psrdada-cpp provides C++ wrappers for a subset for PSRDADA functionality (HDUs,
+read/write clients, etc.) and data processing pipelines build with them.
+
+The documentation of psrdadad-cpp can be found at: http://mpifr-bdg.pages.mpcdf.de/psrdada_cpp/
+
diff --git a/doc/index.rst b/doc/index.rst
index 04f79865..e646ddcf 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,5 +1,10 @@
-PSRDADA CPP Documentation lorem Ipsum
+=========================
+PSRDADA-CPP Documentation
+=========================
+psrdada-cpp provides C++ wrappers for a subset for `PSRDADA
+<http://psrdada.sourceforge.net/>` functionality (HDUs, read/write clients,
+etc.) and data processing pipelines build with them.
Contents
========
--
GitLab