From 26db3318d7f5c1373ca7cb4aa6ac156af2d151fd Mon Sep 17 00:00:00 2001 From: teddygroves Date: Mon, 2 Dec 2024 16:14:36 +0100 Subject: [PATCH] Readme --- .github/workflows/run_tests.yml | 1 - .pre-commit-config.yaml | 1 - README.md | 11 +++++++++++ test/test.tex | 1 - 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.github/workflows/run_tests.yml b/.github/workflows/run_tests.yml index b6be035..0af139e 100644 --- a/.github/workflows/run_tests.yml +++ b/.github/workflows/run_tests.yml @@ -41,4 +41,3 @@ jobs: - name: Run tests run: uv run pytest tests - diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b6e5bff..9b161d7 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -13,4 +13,3 @@ repos: - id: ruff # Run the formatter. - id: ruff-format - diff --git a/README.md b/README.md index e69de29..b62d461 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,11 @@ +# Refcheck + +![Tests](https://github.com/dtu-qmcm/refcheck/.github/workflows/run_tests.yml/badge.svg) + +This repository contains the source code for a tiny web app that extracts the DOIs from a document and presents them in a clickable list. + +You might want to do this to check if your grant application contains any incorrect DOI links, or if the links don't match the references as they are supposed to. + +Check out the app here: . + +Refcheck uses [pypandoc](https://github.com/JessicaTegner/pypandoc) to convert document formats and is written and hosted using [Streamlit](https://streamlit.io/). diff --git a/test/test.tex b/test/test.tex index aa66bc0..6003eaf 100644 --- a/test/test.tex +++ b/test/test.tex @@ -4,4 +4,3 @@ My document contains a doi \href{https://doi.org/10.1021/acssynbio.3c00662}{https://doi.org/10.1021/acssynbio.3c00662}. Here's another one! https://doi.org/10.1021/acssynbio.4c00035 -