[Doc] Update README.md #4139
Merged
[Doc] Update README.md #4139
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/taichi-api-docs-preview/taichi/D2eFnAbv8jQJk5aangBWendjmpzL [Deployment for 9567e64 canceled] |
|
✔️ Deploy Preview for docsite-preview canceled. 🔨 Explore the source changes: 9567e64 🔍 Inspect the deploy log: https://app.netlify.com/sites/docsite-preview/deploys/61f1471d01437600078328e0 |
|
/format |
writinwaters
suggested changes
Jan 26, 2022
Co-authored-by: Vissidarte-Herman <93570324+Vissidarte-Herman@users.noreply.github.com>
Co-authored-by: Vissidarte-Herman <93570324+Vissidarte-Herman@users.noreply.github.com>
Co-authored-by: Vissidarte-Herman <93570324+Vissidarte-Herman@users.noreply.github.com>
Co-authored-by: Vissidarte-Herman <93570324+Vissidarte-Herman@users.noreply.github.com>
Co-authored-by: Vissidarte-Herman <93570324+Vissidarte-Herman@users.noreply.github.com>
Co-authored-by: Vissidarte-Herman <93570324+Vissidarte-Herman@users.noreply.github.com>
Co-authored-by: Vissidarte-Herman <93570324+Vissidarte-Herman@users.noreply.github.com>
Co-authored-by: Vissidarte-Herman <93570324+Vissidarte-Herman@users.noreply.github.com>
k-ye
commented
Jan 26, 2022
writinwaters
suggested changes
Jan 26, 2022
Co-authored-by: Vissidarte-Herman <93570324+Vissidarte-Herman@users.noreply.github.com>
ailzhang
approved these changes
Jan 26, 2022
|
|
||
| ```bash | ||
| python3 -m pip install taichi | ||
| pip install -i https://test.pypi.org/simple/ taichi-nightly |
There was a problem hiding this comment.
IMHO we still need a big warning for nightlies given how bleeding-edge they are. :P
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issue = /
A major revamp of Taichi's README. To preview the full content, please go to https://github.com/k-ye/taichi/tree/readme
I've collected and went through a dozen OSS README (see https://o9ixctz0o7.feishu.cn/docs/doccnPa9jwJ1qxdapFyYWpUrGqh#), and reshaped Taichi's README to follow this structure: