From e4d403717771d181db8c8f4531e9b86a2301f99e Mon Sep 17 00:00:00 2001 From: Sai Sneha Date: Mon, 29 Apr 2024 14:11:30 +0530 Subject: [PATCH] docs: changed readme from rst to md --- README.md | 18 ++++++++++++++++++ README.rst | 20 -------------------- 2 files changed, 18 insertions(+), 20 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..7609d12 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Data Standards for Environmental Surveillance (dses) + +> [!WARNING] +> This documentation is under active development and might be changing. Check out our Github to see the latest changes. + +This is the documentation for the data standards for environmental surveillance, developed by the Data Science Innovation Hub at [ARTPARK](https://www.artpark.in/) at the [Indian Institute of Science](https://iisc.ac.in). + +The aim is to create a set of data standards, along the lines of [`FHIR HL7`](https://hl7.org/fhir/) that are fast to adopt, interoperable, and can be scaled to any kind of disease while allowing extensibility for any user's specific use-case. + +Contributing +------------- + +Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms. + +Credits +------------- + +Data Standards for Environmental Surveillance [`dses`](https://github.com/dsih-artpark/dses) was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the [`py-pkgs-cookiecutter template`](https://github.com/py-pkgs/py-pkgs-cookiecutter). The documentation is rendered using [`sphinx`](https://www.sphinx-doc.org/) and hosted on [`readthedocs.io`](https://readthedocs.io), and uses [`poetry`](https://python-poetry.org/) to manage dependencies in the rendering scripts. diff --git a/README.rst b/README.rst deleted file mode 100644 index ff8878a..0000000 --- a/README.rst +++ /dev/null @@ -1,20 +0,0 @@ -#################################################### -Data Standards for Environmental Surveillance (dses) -#################################################### - -.. warning:: - This documentation is under active development and might be changing. Check out our Github to see the latest changes. - -This is the documentation for the data standards for environmental surveillance, developed by the Data Science Innovation Hub at `ARTPARK `_ at the `Indian Institute of Science `_. - -The aim is to create a set of data standards, along the lines of `FHIR HL7 `_ that are fast to adopt, interoperable, and can be scaled to any kind of disease while allowing extensibility for any user's specific use-case. - -Contributing -------------- - -Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms. - -Credits -------------- - -Data Standards for Environmental Surveillance (`dses `_) was created with `cookiecutter `_ and the `py-pkgs-cookiecutter` `template `_. The documentation is rendered using `sphinx `_ and hosted on `readthedocs.io `_, and uses `poetry `_ to manage dependencies in the rendering scripts.