From 68e19d864c09644422d43e79f53caf1aa5543295 Mon Sep 17 00:00:00 2001 From: Nose Date: Sat, 7 Mar 2026 01:34:48 -0800 Subject: [PATCH] readme updates --- README.md | 45 ++++----------------------------------------- 1 file changed, 4 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 0ed2da3..d459531 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ -# Tarot Time +# TaroTime A web-based esoteric correspondence app for tarot, astrology, calendars, symbols, and related systems. [![Node.js](https://img.shields.io/badge/Node.js-18%2B-5FA04E?logo=node.js&logoColor=white)](https://nodejs.org/) [![Git](https://img.shields.io/badge/VCS-Git-F05032?logo=git&logoColor=white)](https://git-scm.com/) -[![Forgejo Repo](https://img.shields.io/badge/Forgejo-tarot--time-0E9384?logo=forgejo&logoColor=white)](https://code.glowers.club/goyimnose/tarot-time) [![Deck Repository](https://img.shields.io/badge/Decks-tarot--deck-1D4ED8)](https://code.glowers.club/goyimnose/tarot-deck) ## Features @@ -23,51 +22,15 @@ A web-based esoteric correspondence app for tarot, astrology, calendars, symbols 4. Start the app. ```powershell -git clone https://code.glowers.club/goyimnose/tarot-time.git -Set-Location .\tarot-time +git clone https://code.glowers.club/goyimnose/taroTime.git +Set-Location .\TaroTime npm install npm run start ``` The app opens in your browser (typically at `http://127.0.0.1:8080`). -## Deck Repository (Install Ready) -Use this companion repository for downloadable decks: - -- https://code.glowers.club/goyimnose/tarot-deck - -Typical flow: - -1. Clone the deck repository somewhere local. -2. Copy one or more deck folders into `asset/tarot deck/`. -3. Validate and regenerate the deck registry. - -```powershell -git clone https://code.glowers.club/goyimnose/tarot-deck.git -# Copy selected deck folder(s) into Tarot Time deck directory. -npm run validate:decks -npm run start -``` - -## Deck Authoring and Validation - -Deck discovery is registry-driven and generated automatically. - -1. Copy `asset/tarot deck/_template/` to a new folder under `asset/tarot deck/`. -2. Rename the new folder and update its `deck.json`. -3. Add card image files matching the naming rules in the manifest. -4. Run `npm run validate:decks` before publishing/testing. -5. Run `npm run start` (or `npm run generate:decks`) to rebuild `asset/tarot deck/decks.json`. - -Rules and behavior: - -- Folders without `deck.json` are ignored. -- Folders beginning with `_` or `.` are ignored (safe for `_template`). -- `_template` includes `deck.canonical-map.example.json` for explicit major-card file mapping. -- `_template/STRUCTURE.md` documents recommended `majors/` and `minors/` layouts. -- Manifests may override labels with `nameOverrides` and `minorNameOverrides`. -- Invalid manifests or missing mapped files are skipped with terminal warnings. ## NPM Scripts @@ -80,5 +43,5 @@ Rules and behavior: ## Project Links -- Main app: https://code.glowers.club/goyimnose/tarot-time +- Main app: https://code.glowers.club/goyimnose/tarotime - Deck repo: https://code.glowers.club/goyimnose/tarot-deck