Checklist to MVP - Githubissues

thisisparker / cursewords

:pencil: Terminal-based crossword puzzle solving interface

GNU Affero General Public License v3.0

249 stars 30 forks source link

Checklist to MVP #1

Closed thisisparker closed 5 years ago

thisisparker commented 5 years ago

This thing kind of works! It's been tested on multiple platforms and with variegated input. These are the features still left to implement before an MVP.

[x] Saving progress on a puzzle
[x] Go to numbered square
[x] Control all of the above with ctrl+ commands, displayed in some kind of status bar

At that point, I'll need to put together:

[x] A README file
[x] A license
[x] Pip packaging

Considered but not included in this list are a few other things. For later:

[x] Pausing a puzzle
[x] Timer
[x] Check puzzle
[x] Reveal answers

thisisparker commented 5 years ago

Oh also: docstrings and probably a good solid refactor.

thisisparker commented 5 years ago

I might push the timer to a future release. Not only is it a little tricky to implement while running, but I realized I can't save the time data in the .puz file itself (in case solving takes more than one session) so I will have to come up with a solution for that later.

That probably also means pausing is non-essential for an MVP! Given that I've got saving and ctrl+ commands working, that leaves, basically

Go to numbered square command
Better status bar

thisisparker commented 5 years ago

It turns out you can save the time data in the .puz and I think I'm going to! I had to wrestle a bit with the library to figure it out, but once I got it saving the "markup" information (like whether a box had been checked, etc) in that file, I figured out how to access those additional fields.

thisisparker commented 5 years ago

:tada: