From d10fb819ca415a3d6f5c9ff1c4f27c9c3a95648a Mon Sep 17 00:00:00 2001 From: Erzangel Date: Sat, 3 Aug 2024 11:55:33 +0200 Subject: [PATCH] docs: dumbest readme known to man --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 040246c..b32b23c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ # heron-realm-cards -Attempt at a script that generates cards \ No newline at end of file +Attempt at a script that generates cards + +## Get started + +1. Install `git-lfs` (we are dealing with images after all) +2. Clone the repo +3. Do the `git lfs install` command or whatever, I forgot which one +4. Since there is a **submodule repository**, clone it with `git submodule update --init --recursive` + +### I want to generate cards! + +`python src/generate_cards_mvp.py` + +### I want to contribute! + +1. Go to kindergarten and acquire epic alphabet skills +2. While you're at it, learn maths and read umineko +3. Get a keyboard +4. Try to press keys in a helpful way +5. Push your changes on main without testing +6. Watch the CI break and the world burn + +## A lil todo while I'm at it (probably not the right place) + +- [ ] Factions & actions & sacrifice icons +- [ ] Proper gold / damage / heal spheres that aren't super basic +- [ ] Flavor text implementation +- [ ] \ No newline at end of file