aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Chris Lovering <[email protected]>2024-08-01 21:34:18 +0100
committerGravatar Chris Lovering <[email protected]>2024-08-01 21:34:18 +0100
commitbe4f54e459a740fc2276e7b95097412d158f94b1 (patch)
treee70effcd83920bb9d58aa7c4e91afb8aa9018652
parentInitial commit (diff)
Update README
-rw-r--r--README.md22
1 files changed, 1 insertions, 21 deletions
diff --git a/README.md b/README.md
index 4491923..0e58802 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,4 @@
-# Python template
-
-[![License](https://img.shields.io/github/license/owl-corp/python-template)](https://github.com/owl-corp/python-template)
-
-## Summary
-A template Python repo with docker, linting & CI.
-
-To copy this simply press the "Use this template" green button near the top of the repo.
-
-## Changes required copying
-- Pin the dependencies in [`pyproject.toml`](pyproject.toml) to a specific version
-- Update the `tool.poetry` section of in [`pyproject.toml`](pyproject.toml) to be relevant to your project
-- Run `make lock` to lock poetry dependencies and export to a `requirements.txt` file
-- Rename [`_.github/`](_.github/) to `.github` so that CI runs
-
-## Changes to consider after copying
-- Update the [LICENSE](LICENSE) file
-- Update the schedule of the [dependabot config](.github/dependabot.yml)
-- Add a static type checker, such as mypy or Pyright
-- Delete [`.dockerignore](.dockerignore), [`docker-compose.yml`](docker-compose.yml) and the [build step](_.github/workflows/build.yaml) of CI if you do not plan to use docker.
-
+# Thallium
# Contributing
Run `make` from the project root to both install this project's dependencies & install the pre-commit hooks.