Skip to content

docs: improve README download and usage sections #25

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 18, 2025
Merged

docs: improve README download and usage sections #25

merged 4 commits into from
Jun 18, 2025

Conversation

caidanw
Copy link
Contributor

@caidanw caidanw commented Jun 17, 2025 •
edited
Loading

Summary

  • Enhanced README documentation with clearer instructions for developers
  • Added helpful comments and notes to the Usage section
  • Improved clarity of font implementation guidance

Changes

  • Added note about customizable font path in Usage section
  • Added comments explaining Regular vs RegularSlanted font variants
  • Added new ASCII art to the marketing component

@caidanw caidanw requested a review from jimmylee June 17, 2025 00:41
@jimmylee
Copy link
Collaborator

LGTM, this looks great, thanks @caidanw

jimmylee
jimmylee previously approved these changes Jun 17, 2025
View reviewed changes
@caidanw caidanw merged commit 5084859 into main Jun 18, 2025
1 check passed
@caidanw caidanw deleted the caidanw/update-docs branch June 18, 2025 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jimmylee jimmylee jimmylee left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@caidanw @jimmylee