Skip to content
This repository has been archived by the owner on Jun 2, 2024. It is now read-only.

docs: update readme to support new build system #183

Merged
merged 9 commits into from
May 19, 2024

Conversation

somerand0mcat
Copy link
Contributor

@somerand0mcat somerand0mcat commented May 19, 2024

this PR improves and fixes the readme for the new build system

@somerand0mcat somerand0mcat changed the title update readme update readme on refactor/build-system branch May 19, 2024
@somerand0mcat somerand0mcat changed the title update readme on refactor/build-system branch update readme on rewrite branch May 19, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@isabelroses isabelroses left a comment

Choose a reason for hiding this comment

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

I think adding the $ does more harm then good. Because of the copy button on GitHub code blocks will be impaired.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@uncenter
Copy link
Member

Also ideally the PR title should be using the conventional commits style.

@somerand0mcat
Copy link
Contributor Author

@uncenter @isabelroses i added the code that you guys asked for

@somerand0mcat
Copy link
Contributor Author

Also ideally the PR title should be using the conventional commits style.

maybe

Copy link
Contributor

@nullishamy nullishamy left a comment

Choose a reason for hiding this comment

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

Small things here and there, we don't need this to be perfect for our first iteration 👍

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@nullishamy
Copy link
Contributor

Also ideally the PR title should be using the conventional commits style.

We can fix this at merge time, no big deal. This is going to get squashed anyways.

@nullishamy nullishamy changed the title update readme on rewrite branch docs: update readme to support new build system May 19, 2024
@somerand0mcat
Copy link
Contributor Author

@nullishamy @uncenter @isabelroses i fixed the issues

@uncenter
Copy link
Member

@nullishamy @uncenter @isabelroses i fixed the issues

Instead of re-pinging us there is a button under the "Reviewers" tab on the right panel that lets you re-request a review.

@somerand0mcat
Copy link
Contributor Author

@nullishamy @uncenter @isabelroses i fixed the issues

Instead of re-pinging us there is a button under the "Reviewers" tab on the right panel that lets you re-request a review.

oh yeah i forgot about that

Copy link
Contributor

@nullishamy nullishamy left a comment

Choose a reason for hiding this comment

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

Small bits.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@nullishamy nullishamy left a comment

Choose a reason for hiding this comment

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

This needs merged after #178, so lets wait for that. Otherwise LGTM.

@somerand0mcat
Copy link
Contributor Author

This needs merged after #178, so lets wait for that. Otherwise LGTM.

alright

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
@nullishamy
Copy link
Contributor

Freezing this PR, no more changes are to be made. We will rework the README further once we release the new major. Subsequent change requests will be ignored.

@somerand0mcat
Copy link
Contributor Author

Freezing this PR, no more changes are to be made. We will rework the README further once we release the new major. Subsequent change requests will be ignored.

alr

@sgoudham sgoudham marked this pull request as draft May 19, 2024 17:01
@catppuccin catppuccin locked as resolved and limited conversation to collaborators May 19, 2024
@nullishamy nullishamy marked this pull request as ready for review May 19, 2024 17:12
@nullishamy nullishamy merged commit c9f3b24 into catppuccin:refactor/build-system May 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants