Skip to content

Update README.md to recap all snippets in one#2

Open
alexandreelise wants to merge 1 commit intoRubixML:masterfrom
alexandreelise:patch-1
Open

Update README.md to recap all snippets in one#2
alexandreelise wants to merge 1 commit intoRubixML:masterfrom
alexandreelise:patch-1

Conversation

@alexandreelise
Copy link
Copy Markdown

Recap all in one snippet to quickly try and iterate quickly if necessary. Attempt to lower the barrier to entry and allow even non-technical people to follow the steps and easily try RubixML. @andrewdalpino look if everything is ok or any other maintainers.

Recap all in one snippet to quickly try and iterate quickly if necessary. Attempt to lower the barrier to entry and allow even non-technical people to follow the steps and easily try RubixML.
@andrewdalpino look if everything is ok or any other maintainers.
Copy link
Copy Markdown
Member

@andrewdalpino andrewdalpino left a comment

Choose a reason for hiding this comment

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

I like it, just curious about the whitespace!

Comment thread README.md
### Recap all in one snippet:

```php

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why the whitespace?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

It to make it more readable. Rather than compact code. Since humans read the code. It's not scrambled obfuscated assembly, basically. Easy for non-technical people to read this like prose and say: "I kinda get it". That's the main reason behind the whitespace in this snippet.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

It is also to not confuse the markdown parser. But as you might say, there is the preview to see if everything is ok. I can change this if it's a concern for you. Trying to be helpful here.

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