Skip to content

Commit

Permalink
docs: update docs (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
orangekame3 authored Dec 4, 2024
1 parent fc544cd commit 0873d78
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 69 deletions.
67 changes: 0 additions & 67 deletions README copy.md

This file was deleted.

12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# QDash
<div align="center">

<h1> 📊 QDash </h1>

</div>

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

QDash is a web application that provides a user-friendly interface to manage and monitor the execution of calibration workflows.

Expand Down Expand Up @@ -47,12 +53,14 @@ docker exec -it qdash-devcontainer /bin/bash -c "python init/setup.py teardown-a

## Documentation

- [Documentation Home](https://oqtopus-team.github.io/qdash/)
- [Documentation Home](https://qdash.readthedocs.io/en/stable/)

## CITATION

You can use the DOI to cite QDash in your research.

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14277283.svg)](https://doi.org/10.5281/zenodo.14277283)

Citation information is also available in the [CITATION](https://github.com/oqtopus-team/qdash/blob/main/CITATION.cff) file.

## Contact
Expand Down

0 comments on commit 0873d78

Please sign in to comment.