Nits to README - crossword.koplugin - Unnamed repository; edit this file 'description' to name the repository. (DIR) Log (DIR) Files (DIR) Refs (DIR) Submodules (DIR) README (DIR) LICENSE --- (DIR) commit de84eea66adc3722e8dfd10f6d4de9247c704f4f (DIR) parent 144f3b323a962a69cc295d2e522cd79ea588f7a1 (HTM) Author: Scarlett McAllister <no+reply@roygbyte.com> Date: Fri, 1 Sep 2023 18:18:19 -0300 Nits to README Diffstat: M README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) --- (DIR) diff --git a/README.md b/README.md @@ -1,12 +1,12 @@ # Crossword -Solve crosswords on you [KOReader](https://github.com/koreader/koreader) powered device! +Solve crosswords on your [KOReader](https://github.com/koreader/koreader) powered device! ![kocrossword_desk](https://user-images.githubusercontent.com/82218266/156276756-26628c01-8441-44eb-8c09-b8d14c515c31.png) ## Installation -### Get the projectt files and transfer them to your device. +### Get the project files and transfer them to your device. 1. Download or clone this repository to your computer. 2. Initialize the [submodule](https://github.com/doshea/nyt_crosswords/tree/623e72e99b25a524c85b56bf832dd7cd8c2a34a9) (run `git submodule update --init` inside the `crossword.koplugin` folder, or visit the submodule repo, download it to your machine, and place it in this project's directory) @@ -22,6 +22,8 @@ Solve crosswords on you [KOReader](https://github.com/koreader/koreader) powered ## Development +See my article ["How I develop plugins for KOReader"](https://roygbyte.com/how_i_develop_plugins_for_koreader.html) for an overview of this plugin's development process. + ### Testing Copy `crossword_spec.koplugin` into `koreader/spec/unit`. Run the tests with `./kodev test front crossword_spec.lua`.