Update README file #17
Conversation
There was a problem hiding this comment.
Initial review. Commit message should mention that this is creating the README, not just updating it.
We'd also discussed having an overview of TPM activity in here - setup instructions are good, but a note about how the emulator differs, what the consequences are, etc. would be nice.
README.md
Outdated
| # Keylime | ||
| [](https://www.gnu.org/licenses/lgpl-3.0) | ||
|
|
||
| This is a Rust implementation of [Python-Keylime](https://github.com/mit-ll/python-keylime) from MIT Lincoln Lab. |
There was a problem hiding this comment.
Worth mentioning here that we're only focused on the cloud node. (You could mention that that could change in the future too if you want.)
There was a problem hiding this comment.
Added keylime explanation.
README.md
Outdated
|
|
||
| ## Reference | ||
| 1. Keylime Paper: [here](https://github.com/mit-ll/python-keylime/blob/master/doc/tci-acm.pdf) | ||
| 2. Python-Keylime: [here](https://github.com/mit-ll/python-keylime) |
There was a problem hiding this comment.
Convention has this written "python-keylime" (not "Python-Keylime") because that's how Python does it.
There was a problem hiding this comment.
Changed to python-keylime
README.md
Outdated
| ``` | ||
| $ cargo test | ||
| ``` | ||
| If you want to run unit test in order using single thread, use this command. |
README.md
Outdated
| ## Prerequisite | ||
|
|
||
| **Rust** | ||
| Make sure Rust is installed before running Keylime. Installation instruction can be found [here](https://www.rust-lang.org/en-US/install.html). |
There was a problem hiding this comment.
Please wrap all lines at 78 characters, as elsewhere in the codebase.
There was a problem hiding this comment.
Wrapped at 78 widths.
leonjia0112
force-pushed
the
update-readme
branch
3 times, most recently
from
2339cc5 to
4ac1443
Compare
|
Ready for review |
[[email protected]: Fixed overview bullet points. Also clean up language and fix spelling errors.]
frozencemetery
force-pushed
the
update-readme
branch
from
4ac1443 to
c53bf40
Compare
|
I made some changes. Please take a look at the difference. Thanks |
Add content: prerequisite, installation, and testing to the README file. I didn't put everything into the README file, the stuff I put in there are based on our current status. Ready for a review. Comment and suggestion needed. Thanks.