Skip to content

Commit a5ef18b

Browse files
jeertmansjeertmans
committed
wip(docs): updates
1 parent c7d83a8 commit a5ef18b

File tree

4 files changed

+122
-96
lines changed

4 files changed

+122
-96
lines changed

‎README.md

Lines changed: 4 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,7 @@ Manim Slides will *automatically* detect the one you are using!
2525
> with a lot more features!
2626
2727
- [Installation](#installation)
28-
* [Dependencies](#dependencies)
29-
* [Pip install](#pip-install)
30-
* [Install From Repository](#install-from-repository)
3128
- [Usage](#usage)
32-
* [Basic Example](#basic-example)
33-
* [Key Bindings](#key-bindings)
34-
* [Interactive Tutorial](#interactive-tutorial)
35-
* [Other Examples](#other-examples)
3629
- [Comparison with Similar Tools](#comparison-with-similar-tools)
3730
- [F.A.Q](#faq)
3831
* [How to increase quality on Windows](#how-to-increase-quality-on-windows)
@@ -43,62 +36,10 @@ Manim Slides will *automatically* detect the one you are using!
4336

4437
## Installation
4538

46-
<!-- start install -->
47-
48-
While installing Manim Slides and its dependencies on your global Python is fine,
49-
we recommend using a virtual environment
50-
(e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.
51-
52-
### Dependencies
53-
54-
<!-- start deps -->
55-
56-
Manim Slides requires either Manim or ManimGL to be installed.
57-
Having both packages installed is fine too.
58-
59-
If none of those packages are installed, please refer to their specific installation guidelines:
60-
- [Manim](https://docs.manim.community/en/stable/installation.html)
61-
- [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)
62-
63-
> [!NOTE]
64-
> If you install Manim from its git repository, as suggested by ManimGL,
65-
> make sure to first check out a supported version (e.g., `git checkout tags/v1.6.1`
66-
> for ManimGL), otherwise it might install an unsupported version of Manim!
67-
> See [#314](https://github.com/jeertmans/manim-slides/issues/314) for an example.
68-
69-
<!-- end deps -->
70-
71-
### Pip Install
72-
73-
> [!NOTE]
74-
> For an easy and safe installation, use [`pipx`](https://pipx.pypa.io/)
75-
> instead of `pip`.
76-
77-
The recommended way to install the latest release is to use pip:
78-
79-
```bash
80-
pipx install manim-slides
81-
```
82-
83-
Optionally, you can also install Manim or ManimGL using extras[^1]:
84-
85-
```bash
86-
pip install "manim-slides[manim]" # For Manim
87-
# or
88-
pip install "manim-slides[manimgl]" # For ManimGL
89-
```
90-
91-
[^1]: You still need to have Manim or ManimGL platform-specific dependencies
92-
installed on your computer.
93-
94-
### Install From Repository
95-
96-
An alternative way to install Manim Slides is to clone the git repository,
97-
and install from there: read the
98-
[contributing guide](https://eertmans.be/manim-slides/contributing/workflow.html)
99-
to know how to process.
100-
101-
<!-- end install -->
39+
Manim Slides requires either Manim or ManimGL to be installed, along
40+
with their dependencies. Please checkout the
41+
[documentation](https://eertmans.be/manim-slides/)
42+
for detailed install instructions.
10243

10344
## Usage
10445

@@ -168,35 +109,6 @@ manim-slides BasicExample
168109

169110
<!-- end usage -->
170111

171-
## Key Bindings
172-
173-
The default key bindings to control the presentation are:
174-
175-
<picture>
176-
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/wizard_dark.png">
177-
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/wizard_light.png">
178-
<img alt="Manim Slides Wizard" src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/wizard_light.png">
179-
</picture>
180-
181-
182-
You can run the **configuration wizard** to change those key bindings:
183-
184-
```bash
185-
manim-slides wizard
186-
```
187-
188-
A default file can be created with:
189-
190-
```bash
191-
manim-slides init
192-
```
193-
194-
> [!NOTE]
195-
> `manim-slides` uses key codes, which are platform dependent.
196-
> Therefore, sharing keys configuration files accross OSes or keyboards
197-
> is not recommended. Instead, use default key-bindings, or generate
198-
> a new config with `manim-slides wizard`.
199-
200112
## Interactive Tutorial
201113

202114
Click on the image to watch a slides presentation that explains to you how

‎docs/source/contributing/workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document is there to help you recreate a working environment for Manim Slid
44

55
## Dependencies
66

7-
```{include} ../../../README.md
7+
```{include} ../quickstart.md
88
:start-after: <!-- start deps -->
99
:end-before: <!-- end deps -->
1010
```

‎docs/source/installation.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Installation
2+
3+
<!-- start install -->
4+
5+
While installing Manim Slides and its dependencies on your global Python is fine,
6+
we recommend using a virtual environment
7+
(e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.
8+
9+
### Dependencies
10+
11+
<!-- start deps -->
12+
13+
Manim Slides requires either Manim or ManimGL to be installed.
14+
Having both packages installed is fine too.
15+
16+
If none of those packages are installed, please refer to their specific installation guidelines:
17+
- [Manim](https://docs.manim.community/en/stable/installation.html)
18+
- [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)
19+
20+
:::{warning}
21+
If you install Manim from its git repository, as suggested by ManimGL,
22+
make sure to first check out a supported version (e.g., `git checkout tags/v1.6.1`
23+
for ManimGL), otherwise it might install an unsupported version of Manim!
24+
See [#314](https://github.com/jeertmans/manim-slides/issues/314) for an example.
25+
:::
26+
27+
<!-- end deps -->
28+
29+
### Pip Install
30+
31+
:::{note}
32+
For an easy and safe installation, use [`pipx`](https://pipx.pypa.io/)
33+
instead of `pip`.
34+
:::
35+
36+
The recommended way to install the latest release is to use pip:
37+
38+
```bash
39+
pipx install manim-slides
40+
```
41+
42+
Optionally, you can also install Manim or ManimGL using extras[^1]:
43+
44+
```bash
45+
pip install "manim-slides[manim]" # For Manim
46+
# or
47+
pip install "manim-slides[manimgl]" # For ManimGL
48+
```
49+
50+
[^1]: You still need to have Manim or ManimGL platform-specific dependencies
51+
installed on your computer.
52+
53+
### Install From Repository
54+
55+
An alternative way to install Manim Slides is to clone the git repository,
56+
and install from there: read the
57+
[contributing guide](https://eertmans.be/manim-slides/contributing/workflow.html)
58+
to know how to process.
59+
60+
<!-- end install -->

‎docs/source/quickstart.md

Lines changed: 57 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,65 @@
22

33
## Installation
44

5-
```{include} ../../README.md
6-
:start-after: <!-- start install -->
7-
:end-before: <!-- end install -->
5+
<!-- start install -->
6+
7+
While installing Manim Slides and its dependencies on your global Python is fine,
8+
we recommend using a virtual environment
9+
(e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.
10+
11+
### Dependencies
12+
13+
<!-- start deps -->
14+
15+
Manim Slides requires either Manim or ManimGL to be installed.
16+
Having both packages installed is fine too.
17+
18+
If none of those packages are installed, please refer to their specific installation guidelines:
19+
- [Manim](https://docs.manim.community/en/stable/installation.html)
20+
- [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)
21+
22+
:::{warning}
23+
If you install Manim from its git repository, as suggested by ManimGL,
24+
make sure to first check out a supported version (e.g., `git checkout tags/v1.6.1`
25+
for ManimGL), otherwise it might install an unsupported version of Manim!
26+
See [#314](https://github.com/jeertmans/manim-slides/issues/314) for an example.
27+
:::
28+
29+
<!-- end deps -->
30+
31+
### Pip Install
32+
33+
:::{note}
34+
For an easy and safe installation, use [`pipx`](https://pipx.pypa.io/)
35+
instead of `pip`.
36+
:::
37+
38+
The recommended way to install the latest release is to use pip:
39+
40+
```bash
41+
pipx install manim-slides
42+
```
43+
44+
Optionally, you can also install Manim or ManimGL using extras[^1]:
45+
46+
```bash
47+
pip install "manim-slides[manim]" # For Manim
48+
# or
49+
pip install "manim-slides[manimgl]" # For ManimGL
850
```
951

52+
[^1]: You still need to have Manim or ManimGL platform-specific dependencies
53+
installed on your computer.
54+
55+
### Install From Repository
56+
57+
An alternative way to install Manim Slides is to clone the git repository,
58+
and install from there: read the
59+
[contributing guide](https://eertmans.be/manim-slides/contributing/workflow.html)
60+
to know how to process.
61+
62+
<!-- end install -->
63+
1064
## Creating your first slides
1165

1266
```{include} ../../README.md

0 commit comments

Comments
 (0)