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

docs: update github page + some readme improvements #19

Merged
merged 3 commits into from
Dec 29, 2023

Conversation

FranckG28
Copy link
Contributor

Github Page :

image
  • Updated tailwindcss version
  • I've removed the section about doc generation since it's already written in the README, i've replaced it with a link back to the github project. It allow us to have one only source for the doc generation tutorial.

README :

  • i've decreased the title hierarchy by one to have only one H1 title that is the title of the project.
  • added macos support

note that a lot of links in the table of content doesn't works because of the emojis titles. You can use the markdownlint extension to spot them ;)

typedef.h :

  • i've added the corresponding operators next to the enum

@FranckG28 FranckG28 self-assigned this Dec 29, 2023
@FranckG28 FranckG28 marked this pull request as ready for review December 29, 2023 17:35
Copy link
Member

@jvondermarck jvondermarck left a comment

Choose a reason for hiding this comment

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

like
That's such a great job and very good constructive comments! I agree with these changes, it's much better! Thank you so much! ✅😎

@jvondermarck jvondermarck merged commit 24e49b8 into master Dec 29, 2023
1 check passed
@jvondermarck jvondermarck deleted the fg/docs/improvements branch December 30, 2023 20:39
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