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

Need more works on documentation #2

Open
jjyr opened this issue Dec 26, 2020 · 1 comment
Open

Need more works on documentation #2

jjyr opened this issue Dec 26, 2020 · 1 comment

Comments

@jjyr
Copy link
Owner

jjyr commented Dec 26, 2020

Currently, the documentation is mixed with many old x86 contents, needs to be rewritten for RISC-V.

@albertvanderhorst
Copy link

albertvanderhorst commented Jan 1, 2021

For example. You must specify the operating system were you run qemu. You must refer to where qemu that is apparently necessary can be found. On second consideration I find this information in jonesforth.S. So you can just refer to that source in the .md file. But you must do it.

P.S. jonesforth is loosely based on ciforth (present on this github) which is based on good old fig-Forth.
If you borrow from ciforth you may end up with a fully documented system with comprehensive testing.
Its documentation for users is far superior than jonesforth, and the Forth is more powerful. If you pass the ciforth tests, then the ciforth library will work. Jonesforth is in the first place for those interested in the inner workings. I am the author of ciforth and willing to help. While jonesforth documents assembler words meticulously, this may not be worth it. Once you understand basic Forth principles and the rics V assembler almost everything becomes trivial.
Alternatively you may look into lina that is also on this github.

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

2 participants