Development guide for Crosswords
This is the development guide for Crosswords and Crossword Editor. It will help you understand how the applications fit together and how best to work with the codebase and project.
Contributing to the Project
For those interested in contributing to the project, please follow the guides below. In particular:
Building and running it from source (Additional Mac OS hints)
Contributor’s guide — coming soon!
Navigating the code base
The codebase can be complex to navigate. These guides help developers understand how things fit together.
Crosswords overview — guide to the main game
Crosswords Editor overview — guide to the editor
Shared code overview — guide to code shared between the two applications
Naming disambiguation — guide to understanding source code file names
Designs
Complex sections of the code have their own documentation to describe how they work. This is a list of the current designs:
Crosswords:
Puzzle Sets:
Crossword Editor:
Shared Code:
In progresss / Drafts
These are proposals that haven’t been implemented yet, or still need review.
Deprecated Designs
Some designs are obsolete and no longer are relevant. We keep them around for historical interest, and to help reconstruct complex decisions.
Packagers
Tips for distributing Crosswords:
Maintainers
Internal documentation for the core Maintainers:
TODO: CI documentation