search

awwad / uptane

Uptane, security framework for automotive updates
https://uptane.github.io/
MIT License
10 stars 42 forks source link

Update README.md - (WIP: Review, edit text, and include attack sketch for uptane/uptane#26) #35

Closed vladimir-v-diaz closed 7 years ago

vladimir-v-diaz commented 7 years ago

Edits to text after following the instructions and running the demo.

Should we make it clear how users can start the Python interpreter and enter commands on the Python (>>>) prompt? Not everyone trying out the reference implementation might be familiar with Python.

vladimir-v-diaz commented 7 years ago

GitHub encourages users to keep the commit message short (and add more detail in the commit summary). Let me know if you prefer longer, more detailed commit messages.

awwad commented 7 years ago

I'm fine either way on commit messages. I do prefer pull request titles to be more expressive, since they're viewed in a list of PRs and should be distinguishable, I guess, but for commit messages, short message && details in summary makes sense.

vladimir-v-diaz commented 7 years ago

Updated the PR title. Be default, the GitHub online editor adds "Update README.md" and puts the cursor on the summary input box. I usually just put the cursor over the PR title to see the commit summary, but it's probably more convenient if the titles were distinguishable.

vladimir-v-diaz commented 7 years ago

I can add the rest of Python interpreter prompts, if you prefer. From past experience, it wasn't clear to users which commands should be entered on the interpreter prompt, bash shell, or written to a Python module.