TabletopAssistant / DiceKit

Swift framework for expressing and evaluating dice notation (e.g., d20, 4d6+4, 3d8×10+2), which is commonly used in tabletop role-playing games.
Apache License 2.0
14 stars 1 forks source link

Update the Tome of Knowledge to bring potential contributors up to speed #123

Open brentleyjones opened 8 years ago

brentleyjones commented 8 years ago

It's not readily clear how DiceKit is put together. There is the separation of ExpressionType and ExpressionTypeResult that might not make sense to begin with. It also might not make sense why ExpressionTypeResult isn't the actual result, but computes it. These topics, and any other confusing ones, need to be covered in the Tome of Knowledge, to ensure that after it's fully read someone would be able to jump into the code base and make sense of it.