openDLX
openDLX copied to clipboard
Create tutorial and/or add documentation
The latest commit 615acbe8fddf67862a80712572d729ab09614e81 reminded me to bring this up.
I think having a tutorial is a good one, and someone should start writing one at some point (this can be kept in an extra branch and tracked with a pull request, for example).
Additionally, some documentation should be included, detailing the supported instruction set, the behavior of the simulator with/without forwarding and of the traps, etc.
Parts of the existing internal uni documentation could be used (though licensing/usage/copyright should be double-checked; same goes for parts of WinDLX's docs currently in use internally).
Originally a tutorial was planned, but we had to cancel it for time reasons. Moreover, building a good tutorial from the scratch is lots of work.
The information about the ISA and the behaviour with the supported options is documented at Augsburg. I'll check the available informations and could set up a simple help page, or similar.
That would be a good start. Without documentation, the project is nearly worthless to other people (unless they work through all of the code, which no one in their right mind will do).
As I said, documentation -- a tutorial isn't necessary right away. And even if we start one (for example, on the wiki here or at sf.net), it can evolve over time, maybe with help from users.