From c74a709afe913cae07945221c670540bbc818e49 Mon Sep 17 00:00:00 2001 From: scarf Date: Mon, 5 Jun 2023 16:17:34 +0900 Subject: [PATCH] docs(README): improve accesibility (#209) * docs(README): add `alt` for all images improves accessibility for non-visual environment. * docs(README): add Steam Views Badge * docs(README): fix incorrect project build command * chore: simplify exclude field support added in deno v1.34: https://deno.com/blog/v1.34#exclude-files-or-folders-for-all-sub-commands --- README.md | 34 +++++++++++++++++++++------------- deno.jsonc | 19 +++---------------- 2 files changed, 24 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 50980b0..852d4e9 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,21 @@ -[![](docs/repoTemplate/RepoTemplate.png)][workshop] +[![Banner image depicting Kirisame Marisa and the title 'Marisa: Continued'](docs/repoTemplate/RepoTemplate.png)][workshop]
- - + Kotlin Badge + Gradle Badge - + Latest Release Version Badge - + Steam Views Badge + + + Subscriptions Badge

Marisa: Continued

@@ -30,9 +38,9 @@ https://user-images.githubusercontent.com/54838975/233419957-b16aaee0-948b-4af9- ### Previews for generated cards
- - - + Double Spark + Binary Stars+ + Max Power
## Content and Gameplay @@ -63,10 +71,10 @@ subscribe [ModTheSpire][modthespire] and [BaseMod][basemod]. [modthespire]: https://steamcommunity.com/sharedfiles/filedetails/?l=koreana&id=1605060445 [basemod]: https://steamcommunity.com/sharedfiles/filedetails/?id=1605833019 -#### Subscribe from Steam Workshop +#### [Subscribe from Steam Workshop][workshop] - steam workshop link + Link to Steam Workshop displaying Project Thumbnail #### Compile from source @@ -76,13 +84,13 @@ subscribe [ModTheSpire][modthespire] and [BaseMod][basemod]. git clone repository `https://github.com/scarf005/Marisa.git` -![](docs/ProjectStructure.png) +![Intellij's Project Structure window, with its Language Level set to 8 and SDK to openjdk-17](docs/ProjectStructure.png) setup java, kotlin, and gradle in your intellij. language version must be 8. ```sh -gradle -t toMods # install once -./gradlew -t toMods --warning-mode all # dev mode: recompile on changes +gradle changelog # install once +./gradlew -t changelog --warning-mode all # dev mode: recompile on changes ``` run gradle task to copy jar into your steam mods folder. diff --git a/deno.jsonc b/deno.jsonc index 5948ebd..5cbbd1a 100644 --- a/deno.jsonc +++ b/deno.jsonc @@ -6,20 +6,7 @@ "schema:fmt": "deno task --cwd localization/ fmt", "link": "deno run --allow-read --allow-write --allow-env ./scripts/link/mod.ts" }, - "fmt": { - "options": { "semiColons": false }, - "files": { - "exclude": ["src/main/kotlin/", "src/main/resources/img", "build/"] - } - }, - "test": { - "files": { - "exclude": ["src/main/kotlin/", "src/main/resources/img", "build/"] - } - }, - "bench": { - "files": { - "exclude": ["src/main/kotlin/", "src/main/resources/img", "build/"] - } - } + "exclude": ["src/main/kotlin/", "src/main/resources/img", "build/"], + "fmt": { "options": { "semiColons": false } }, + "compilerOptions": { "exactOptionalPropertyTypes": true } }