Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion to improve documentation and understanding of program #10

Open
phillipeaton opened this issue Jun 4, 2022 · 1 comment
Open

Comments

@phillipeaton
Copy link

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
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant