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 #2277

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

monkeywithacupcake
Copy link

Makes the cli code copy/pastable by removing the leading $ and adds a note/warning for macOS users regarding python / python3

This is doc only (only touching readme)

[ci skip]

Makes the cli code copy/pastable by removing the leading `$` and adds a note/warning for macOS users regarding python / python3

This is doc only (only touching readme)

[ci skip]
Makes the cli code copy/pastable by removing the leading $ and adds a note/warning for macOS users regarding python / python3

This is doc only (only touching readme)

[ci skip]
@afh
Copy link
Member

afh commented Aug 25, 2023

Thanks for this PR, @monkeywithacupcake. I think it is worthwhile to begin each code block with:

```sh

Copy link
Member

@afh afh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@monkeywithacupcake Please update PR, so that only $ is removed from the code examples instead of enclosing them in a ```-block?

Comment on lines 169 to 170
# or, if you want to use the Boost libraries with suffix -mt, install in
# $HOME/local and build with 2 processes in parallel
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please unindent these 2 lines and remove the leading #, so they appear as regular text.

@afh afh self-assigned this Dec 6, 2023
@afh afh added the easy Trivial changes easy to review label Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy Trivial changes easy to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants