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

Jazz up the README with some badges/logo etc. #605

Merged
merged 4 commits into from
May 2, 2022
Merged

Conversation

FollowTheProcess
Copy link
Collaborator

@FollowTheProcess FollowTheProcess commented Apr 29, 2022

Hey everyone.

Did some lounging in the sun with my laptop today and thought that Nox's README could use a spruce up ✨

I think the docs and the theme are great but a lot of people browse GitHub when looking for new projects and the README is a big part of how people's impressions of a project are formed and the original document needed some jazzing up I think!

I've added some common badges, included the alice logo, given a very brief intro to Nox aswell as install instructions and very brief usage guide.

Let me know what you think!

Copy link
Collaborator

@DiddiLeija DiddiLeija left a comment

Choose a reason for hiding this comment

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

Sounds good to me, it gives some life to the project's cover page. I only made a small spelling suggestion below.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@FollowTheProcess FollowTheProcess merged commit 46152cd into main May 2, 2022
@FollowTheProcess FollowTheProcess deleted the jazz-up-readme branch May 2, 2022 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants