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

chore(docs): warn users about #314 #319

Merged
merged 2 commits into from
Nov 21, 2023
Merged

chore(docs): warn users about #314 #319

merged 2 commits into from
Nov 21, 2023

Conversation

jeertmans
Copy link
Owner

Closes #316

@jeertmans jeertmans added the documentation Improvements or additions to documentation label Nov 21, 2023
README.md Outdated
@@ -51,6 +51,11 @@ If none of those packages are installed, please refer to their specific installa
- [Manim](https://docs.manim.community/en/stable/installation.html)
- [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)

> **NOTE**: if you install Manim from its git repository, as suggested by ManimGL,
make sure to first checkout a supported version (e.g., `git checkout tags/v1.6.1`

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
The word “checkout” is a noun. The verb is spelled with a white space. (NOUN_VERB_CONFUSION[6])
Suggestions: check out
Rule: https://community.languagetool.org/rule/show/NOUN_VERB_CONFUSION?lang=en-US&subId=6
Category: GRAMMAR

Copy link

codecov bot commented Nov 21, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fc59453) 79.39% compared to head (95c8a07) 79.39%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #319   +/-   ##
=======================================
  Coverage   79.39%   79.39%           
=======================================
  Files          20       20           
  Lines        1631     1631           
=======================================
  Hits         1295     1295           
  Misses        336      336           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jeertmans jeertmans merged commit 2b25b6a into main Nov 21, 2023
21 of 22 checks passed
@jeertmans jeertmans deleted the warn branch November 21, 2023 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Warn users about installing Manim or ManimGL from dev branches
1 participant