search

Arakula / dasmfw

The DisASseMbler FrameWork
GNU General Public License v2.0
13 stars 4 forks source link

Suggestion to improve documentation and understanding of program #10

Open phillipeaton opened 2 years ago

phillipeaton commented 2 years ago 
If you think about it, there are various kinds of mutually exclusive options
for a memory cell. These are:
- type (unused / code / data / rmb)
- size (default char / word; dasmfw also has dword for processors that support 4-byte entities)
- formatting (bin / char / dec / hex)
- semantics (const)

The above is really useful for understanding how the program works and what instructions are going to work in the info file.

However, the dasmfw documentation file doesn't mention the above explanation or group the relevant instructions together.

Suggestion is to put the four above headings into the documentation and the relevant instructions under them.

phillipeaton commented 2 years ago

BTW, I setup my text editor with syntax highlighting for info files, coloured according to the groups above, it works really well to highlight errors/inconsistencies.