README.md - crossword.koplugin - Unnamed repository; edit this file 'description' to name the repository.
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) Submodules
(DIR) README
(DIR) LICENSE
---
README.md (1793B)
---
1 # Crossword
2
3 Solve crosswords on your [KOReader](https://github.com/koreader/koreader) powered device!
4
5 
6
7 ## Installation
8
9 ### Get the project files and transfer them to your device.
10
11 1. Download or clone this repository to your computer.
12 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)
13 3. Attach your e-reader to your computer.
14 4. Drag the entire folder (titled `crossword.koplugin`) to your e-reader, placing it in the `plugins` folder located at: `.adds/koreader/plugins/`.
15 5. Restart your device.
16
17 ### Configure the plugin
18
19 1. Launch the plugin on your device (you'll find it in the main toolbar).
20 2. Click on "Settings" in the plugin's menu.
21 3. Click on "Set puzzles folder" and choose the `nyt_crosswords` folder.
22
23 ## Development
24
25 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.
26
27 ### Testing
28
29 Copy `crossword_spec.koplugin` into `koreader/spec/unit`. Run the tests with `./kodev test front crossword_spec.lua`.
30
31 ### Flaws
32
33 - Deleting the crossword history doesn't delete the underlying puzzle values. In other words, you can't delete the history and expect to start a puzzle fresh again.
34 - The puzzle library doesn't show you puzzles you have completed or are working in progress.
35 - There's no congratulatory message upon completing a puzzle (I would expect balloons).
36 - There are no easter eggs.