Skip to content

Commit ad81da9

Browse files
Update README
Add details for installing with Docker
1 parent 98c374c commit ad81da9

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Example: `$ git-sim merge <branch>`
3232
- Animation only: Speed up or slow down animation speed as desired
3333

3434
## Quickstart
35+
Optional: If you prefer using Docker, skip steps (1) and (2) here and jump to the [Docker installation](#docker-installation) section below, then come back here to step (3).
3536

3637
1) **Install Manim and its dependencies for your OS / environment:**
3738
- [Install Manim on Windows](https://docs.manim.community/en/stable/installation/windows.html)
@@ -376,6 +377,33 @@ See **Quickstart** section for details on installing manim and other dependencie
376377
$ pip3 install git-sim
377378
```
378379

380+
## Docker installation
381+
382+
1) Clone down the git-sim repository:
383+
384+
```console
385+
$ git clone https://github.com/initialcommit-com/git-sim.git
386+
```
387+
388+
2) Browse into the `git-sim` folder and build the Docker image:
389+
390+
```console
391+
$ docker build -t git-sim .
392+
```
393+
394+
3) Run git-sim commands as follows:
395+
- Windows: `docker run --rm -v %cd%:/usr/src/git-sim git-sim [global options] <subcommand> [subcommand options]`
396+
- MacOS / Linux: `docker run --rm -v $(pwd):/usr/src/git-sim git-sim [global options] <subcommand> [subcommand options]`
397+
398+
Optional: On MacOS / Linux / or GitBash in Windows, create an alias for the long docker command so your can run it as a normal `git-sim` command. To do so add the following to your `.bashrc` or equivalent (then restart your terminal):
399+
400+
<h5 a><strong><code>.bashrc</code></strong></h5>
401+
```bash
402+
git-sim() { docker run --rm -v $(pwd):/usr/src/git-sim git-sim "$@" }
403+
```
404+
405+
This will enable you to run git-sim subcommands as [described above](#commands).
406+
379407
## Learn More
380408
Learn more about this tool on the [git-sim project page](https://initialcommit.com/tools/git-sim).
381409

0 commit comments

Comments
 (0)