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

Doc: improve README #40

Merged
merged 14 commits into from
Feb 24, 2023
Merged

Doc: improve README #40

merged 14 commits into from
Feb 24, 2023

Conversation

yunwei37
Copy link
Member

@yunwei37 yunwei37 commented Feb 23, 2023

  • move build to doc/build.md
  • move examples to examples/README.md
  • add go examples description
  • add rust runtime description

Any more suggestions? The Chinese documents improvement should be in another PR.

@yunwei37
Copy link
Member Author

yunwei37 commented Feb 23, 2023

shall we keep an example output in readme, to show the usage of this?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/build.md Outdated Show resolved Hide resolved
docs/build.md Outdated Show resolved Hide resolved
docs/build.md Outdated Show resolved Hide resolved
docs/build.md Outdated Show resolved Hide resolved
docs/build.md Outdated Show resolved Hide resolved
docs/build.md Outdated Show resolved Hide resolved
docs/build.md Outdated Show resolved Hide resolved
docs/build.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
yunwei37 and others added 8 commits February 24, 2023 13:24
Co-authored-by: septs <github@septs.pw>
Co-authored-by: septs <github@septs.pw>
Co-authored-by: septs <github@septs.pw>
Co-authored-by: septs <github@septs.pw>
Co-authored-by: septs <github@septs.pw>
Co-authored-by: septs <github@septs.pw>
Co-authored-by: septs <github@septs.pw>
Co-authored-by: ocfox <i@ocfox.me>
README.md Outdated Show resolved Hide resolved
examples/README.md Show resolved Hide resolved
@yunwei37 yunwei37 merged commit fca7030 into main Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants