From 846fb7810293c4cbafbafb0e189fd431ccfbd974 Mon Sep 17 00:00:00 2001 From: Randy West Date: Tue, 9 Jul 2024 20:17:29 -0700 Subject: [PATCH] Add note about how to enable min island count --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 780179e..8b0175b 100644 --- a/README.md +++ b/README.md @@ -501,6 +501,12 @@ to dive into, but here are some tips: [boards.ts](src/types/boards.ts) for details), adding a new board is just a matter of adding a new board definiton and expansion name in these two files. +- If you're adding a new scenario that features a variable number of islands, + enable the _Min Island Count_ constraint by adding your scenario name to + `islandExpansions` at the top of + [src/components/Randomizer.tsx](src/components/Randomizer.tsx). Make sure to + also mention it in the [appropriate README + section](#on-scenarios-with-a-variable-number-of-islands). - All code and docs are formatted using [Prettier](https://prettier.io/) with default options. Any PRs should be, too. - All shuffling logic is thoroughly tested and fully passing. Any fixes or