-
Notifications
You must be signed in to change notification settings - Fork 3
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
Update: readme #77
Update: readme #77
Conversation
Readme file updated for setting up build environment for the project
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you use single-line code blocks instead of having multiple lines every time?
Example:
For Ubuntu, run: `<some command>`
To <do xyz>, run: `<some command>`
I do not know why the CI checks failed, they shouldn't as this only edits the README. We'll ignore that they failed. |
I modified from |
No, this clutters the README. It's fine if you want to add commands but, unless they are very long, please put them on a single line. |
Readme file updated to distinguish between code and text
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a small inconsistency in the ubuntu install lines and I think it would be best to make it one command before the list of prerequisites, clearly stating that this installs all prerequisites.
|
They're two apt-get install commands and if you're going to bother adding those commands, just make it one. And if you make it just one, put it before the lists of packages and state something like "On Ubuntu, run this: .... |
Updated readme for environment setup
Readme file updated for setting up build environment for the project