Skip to content

Commit e7ec719

Browse files
authored
Merge pull request #29 from leotrs/master
fix typo in README and add SSH option
2 parents fb03cde + 2428716 commit e7ec719

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as seen in the videos at [3Blue1Brown](https://www.3blue1brown.com/).
1010

11-
> NOTE: This repository is maintained by the Manim Community, and is not associated with Grant Sanderson or 3Blue1Brown in any way (though we are definitely indebted to him for providing his work to the world). If you want to study how Grant make's his videos, head over to the main repository (3b1b/manim). This is a more frequently updated repository than the main one, and is recommended if you want to use Manim for your own projects.
11+
> NOTE: This repository is maintained by the Manim Community, and is not associated with Grant Sanderson or 3Blue1Brown in any way (though we are definitely indebted to him for providing his work to the world). If you want to study how Grant makes his videos, head over to the main repository (3b1b/manim). This is a more frequently updated repository than the main one, and is recommended if you want to use Manim for your own projects.
1212
1313
## Table of Contents:
1414
- [Installation](#installation)
@@ -161,10 +161,26 @@ Manim runs on Python 3.7+. If you'd like to just use the library, you can instal
161161
pip3 install manimlib
162162
```
163163

164-
However, if you'd like to contribute to and/or help develop `manim-community`, you can clone this branch to your local device. To do this, run the following command (with `git` installed):
164+
However, if you'd like to contribute to and/or help develop
165+
`manim-community`, you can clone this branch to your local device. To do
166+
this, first make sure you have `git` installed. Then, clone this repo by
167+
executing either
168+
169+
```sh
170+
git clone [email protected]:ManimCommunity/manim.git
171+
```
172+
173+
or
165174

166175
```sh
167176
git clone https://github.com/ManimCommunity/manim.git
177+
```
178+
179+
depending on whether you want to use HTTPS or SSH. Finally, run the
180+
following:
181+
182+
```sh
183+
168184
python3 -m pip install -r requirements.txt
169185
```
170186

0 commit comments

Comments
 (0)