Draft of initial RMC documentation #471
Conversation
rmc-docs/src/rmc-tutorial.md
Outdated
There was a problem hiding this comment.
Remove 'reasonable'. Maybe start with some motivation. Why do you want to invest time learning RMC?
There was a problem hiding this comment.
Did the first. I also added more context.
rmc-docs/src/install-guide.md
Outdated
There was a problem hiding this comment.
Maybe add that cargo will handle most of the installation for these dependencies?
rmc-docs/src/install-guide.md
Outdated
There was a problem hiding this comment.
Recommend adding to .bashrc/.bash_profile?
rmc-docs/src/getting-started.md
Outdated
There was a problem hiding this comment.
property tests -> property-based tests?
rmc-docs/src/install-guide.md
Outdated
There was a problem hiding this comment.
Is this command necessary (I don't recall running it in my initial setup). I just did that, and it's been running for over 30 minutes for me and seems to be cloning a lot of repositories:
Cloning into '/home/zyadh/rmc/firecracker'...
Cloning into '/home/zyadh/rmc/library/backtrace'...
Cloning into '/home/zyadh/rmc/library/stdarch'...
Cloning into '/home/zyadh/rmc/src/doc/book'...
Cloning into '/home/zyadh/rmc/src/doc/edition-guide'...
Cloning into '/home/zyadh/rmc/src/doc/embedded-book'...
Cloning into '/home/zyadh/rmc/src/doc/nomicon'...
Cloning into '/home/zyadh/rmc/src/doc/reference'...
Cloning into '/home/zyadh/rmc/src/doc/rust-by-example'...
Cloning into '/home/zyadh/rmc/src/doc/rustc-dev-guide'...
Cloning into '/home/zyadh/rmc/src/llvm-project'...
There was a problem hiding this comment.
I've assumed it was necessary, since our CI is doing it.
tedinski
force-pushed
the
initial-docs
branch
from
bf5469b to
d7909e5
Compare
* Draft of initial RMC documentation * revisions in response to feedback
* Draft of initial RMC documentation * revisions in response to feedback
4 participants
Description of changes:
Some initial documentation for RMC.
Resolved issues:
N/A
Call-outs:
Nothing special.
Testing:
How is this change tested? -
Is this a refactor change? -
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.