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.

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

Better READMEs and Instructions #13

Merged
merged 4 commits into from
Nov 9, 2023
Merged

Better READMEs and Instructions #13

merged 4 commits into from
Nov 9, 2023

Conversation

erikziyunchi
Copy link
Member

@erikziyunchi erikziyunchi commented Oct 30, 2023 •
edited
Loading

Adding READMEs for:

  1. Clarification of code
  2. Instructions of running + developing
  3. Usage of libraries

@erikziyunchi erikziyunchi added the documentation Improvements or additions to documentation label Oct 30, 2023
@gaukas
Copy link
Contributor

gaukas commented Oct 30, 2023

I don't know what would be a better way to dual-license the crates, but here's an example: https://github.com/serde-rs/serde

@gaukas
Copy link
Contributor

gaukas commented Oct 30, 2023 •
edited
Loading

Also if you include [ci skip] in your commit title, CI won't run (which makes more sense for document-only changes and saves your free quota).

(I always refer to this gist for commit tricks/conventions)

@erikziyunchi erikziyunchi changed the title Better READMEs and Instructions Better READMEs and Instructions [ci skip] Oct 30, 2023
@erikziyunchi erikziyunchi changed the title Better READMEs and Instructions [ci skip] Better READMEs and Instructions Oct 31, 2023
gaukas
gaukas approved these changes Nov 9, 2023
View reviewed changes
Copy link
Contributor

@gaukas gaukas left a comment

Choose a reason for hiding this comment

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

LGTM

@erikziyunchi erikziyunchi merged commit 687fa6f into main Nov 9, 2023
5 checks passed
@erikziyunchi erikziyunchi deleted the better-readme branch November 9, 2023 01:04
@erikziyunchi erikziyunchi mentioned this pull request Nov 9, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jmwample jmwample jmwample approved these changes

@gaukas gaukas gaukas approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@erikziyunchi @gaukas @jmwample