From c5da744442d5635e34c097785ada6ec3dd89d15c Mon Sep 17 00:00:00 2001 From: Kyle Kemp Date: Thu, 18 Apr 2024 14:46:04 -0500 Subject: [PATCH] update readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 0d386f2..69af3b3 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,24 @@ This repository obtains and reformats cards for the Leder Spotlight application. - `npm run build:i18n` - build the i18n files and ensure that they're formatted correctly - `npm run validate:card-data` - validate the card data is formatted correctly +## Adding New Content + +### Products + +1. Create a new file matching the product name in `content/meta-data` +1. Create a new folder in `content/card-data` (the name should match the `productName` in the `meta-data` file) +1. Create a new folder in `content/card-images` (the name should match the `productName` in the `meta-data` file) +1. Create a new folder in `content/card-symbols` (the name should match the `productName` in the `meta-data` file) + +Follow the guide for adding a new locale + +### Locale + +1. Create a new folder in `content/card-data/{product}` for the locale (probably `en-US`) + 1. Add a `cards.yml` file here (or, as many separate files as desired - they all get concatenated together) and fill it with card data. +1. Create a new folder in `content/card-images/{product}` for the locale (probably `en-US`) + 1. Fill this folder with the images for the cards for the game. + ## Publishing New Content This is done automatically when a PR is merged to `main`, and isn't intended to be done manually.