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

Update: readme #77

Merged
merged 3 commits into from
Aug 7, 2024
Merged

Update: readme #77

merged 3 commits into from
Aug 7, 2024

Conversation

00thirdeye00
Copy link
Contributor

Readme file updated for setting up build environment for the project

Readme file updated for setting up build environment for the project
Copy link
Member

@robotman2412 robotman2412 left a 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>`

@robotman2412
Copy link
Member

I do not know why the CI checks failed, they shouldn't as this only edits the README. We'll ignore that they failed.

@00thirdeye00
Copy link
Contributor Author

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 modified from single line code (earlier version) to code block type for better understanding. Also, one can copy the code when we have longer commands and execute it. I also have feeling that this is not enough readme for someone to give a head start so I will update it again in the near future.

@robotman2412
Copy link
Member

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
Copy link
Member

@robotman2412 robotman2412 left a 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.

@00thirdeye00
Copy link
Contributor Author

00thirdeye00 commented Aug 7, 2024

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.

  • unlear? did you mean "write command first and explain after it"?
  • "make one command" to install all the prerequisites in one command?

@robotman2412
Copy link
Member

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: ....
Or install: ...."

Updated readme for environment setup
@00thirdeye00 00thirdeye00 merged commit 0e2cb90 into main Aug 7, 2024
6 checks passed
@00thirdeye00 00thirdeye00 deleted the update_readme_main branch August 10, 2024 11:44
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

Successfully merging this pull request may close these issues.

2 participants