Skip to content

Commit

Permalink
wip(docs): updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jeertmans committed Jan 18, 2024
1 parent c7d83a8 commit a5ef18b
Show file tree
Hide file tree
Showing 4 changed files with 122 additions and 96 deletions.
96 changes: 4 additions & 92 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,7 @@ Manim Slides will *automatically* detect the one you are using!
> with a lot more features!
- [Installation](#installation)
* [Dependencies](#dependencies)
* [Pip install](#pip-install)
* [Install From Repository](#install-from-repository)
- [Usage](#usage)
* [Basic Example](#basic-example)
* [Key Bindings](#key-bindings)
* [Interactive Tutorial](#interactive-tutorial)
* [Other Examples](#other-examples)
- [Comparison with Similar Tools](#comparison-with-similar-tools)
- [F.A.Q](#faq)
* [How to increase quality on Windows](#how-to-increase-quality-on-windows)
Expand All @@ -43,62 +36,10 @@ Manim Slides will *automatically* detect the one you are using!

## Installation

<!-- start install -->

While installing Manim Slides and its dependencies on your global Python is fine,
we recommend using a virtual environment
(e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.

### Dependencies

<!-- start deps -->

Manim Slides requires either Manim or ManimGL to be installed.
Having both packages installed is fine too.

If none of those packages are installed, please refer to their specific installation guidelines:
- [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 check out a supported version (e.g., `git checkout tags/v1.6.1`
> for ManimGL), otherwise it might install an unsupported version of Manim!
> See [#314](https://github.com/jeertmans/manim-slides/issues/314) for an example.
<!-- end deps -->

### Pip Install

> [!NOTE]
> For an easy and safe installation, use [`pipx`](https://pipx.pypa.io/)
> instead of `pip`.
The recommended way to install the latest release is to use pip:

```bash
pipx install manim-slides
```

Optionally, you can also install Manim or ManimGL using extras[^1]:

```bash
pip install "manim-slides[manim]" # For Manim
# or
pip install "manim-slides[manimgl]" # For ManimGL
```

[^1]: You still need to have Manim or ManimGL platform-specific dependencies
installed on your computer.

### Install From Repository

An alternative way to install Manim Slides is to clone the git repository,
and install from there: read the
[contributing guide](https://eertmans.be/manim-slides/contributing/workflow.html)
to know how to process.

<!-- end install -->
Manim Slides requires either Manim or ManimGL to be installed, along
with their dependencies. Please checkout the
[documentation](https://eertmans.be/manim-slides/)
for detailed install instructions.

## Usage

Expand Down Expand Up @@ -168,35 +109,6 @@ manim-slides BasicExample

<!-- end usage -->

## Key Bindings

The default key bindings to control the presentation are:

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/wizard_dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/wizard_light.png">
<img alt="Manim Slides Wizard" src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/wizard_light.png">
</picture>


You can run the **configuration wizard** to change those key bindings:

```bash
manim-slides wizard
```

A default file can be created with:

```bash
manim-slides init
```

> [!NOTE]
> `manim-slides` uses key codes, which are platform dependent.
> Therefore, sharing keys configuration files accross OSes or keyboards
> is not recommended. Instead, use default key-bindings, or generate
> a new config with `manim-slides wizard`.
## Interactive Tutorial

Click on the image to watch a slides presentation that explains to you how
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document is there to help you recreate a working environment for Manim Slid

## Dependencies

```{include} ../../../README.md
```{include} ../quickstart.md
:start-after: <!-- start deps -->
:end-before: <!-- end deps -->
```
Expand Down
60 changes: 60 additions & 0 deletions docs/source/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Installation

<!-- start install -->

While installing Manim Slides and its dependencies on your global Python is fine,
we recommend using a virtual environment
(e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.

### Dependencies

<!-- start deps -->

Manim Slides requires either Manim or ManimGL to be installed.
Having both packages installed is fine too.

If none of those packages are installed, please refer to their specific installation guidelines:
- [Manim](https://docs.manim.community/en/stable/installation.html)
- [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)

:::{warning}
If you install Manim from its git repository, as suggested by ManimGL,
make sure to first check out a supported version (e.g., `git checkout tags/v1.6.1`
for ManimGL), otherwise it might install an unsupported version of Manim!
See [#314](https://github.com/jeertmans/manim-slides/issues/314) for an example.
:::

<!-- end deps -->

### Pip Install

:::{note}
For an easy and safe installation, use [`pipx`](https://pipx.pypa.io/)
instead of `pip`.
:::

The recommended way to install the latest release is to use pip:

```bash
pipx install manim-slides
```

Optionally, you can also install Manim or ManimGL using extras[^1]:

```bash
pip install "manim-slides[manim]" # For Manim
# or
pip install "manim-slides[manimgl]" # For ManimGL
```

[^1]: You still need to have Manim or ManimGL platform-specific dependencies
installed on your computer.

### Install From Repository

An alternative way to install Manim Slides is to clone the git repository,
and install from there: read the
[contributing guide](https://eertmans.be/manim-slides/contributing/workflow.html)
to know how to process.

<!-- end install -->
60 changes: 57 additions & 3 deletions docs/source/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,65 @@

## Installation

```{include} ../../README.md
:start-after: <!-- start install -->
:end-before: <!-- end install -->
<!-- start install -->

While installing Manim Slides and its dependencies on your global Python is fine,
we recommend using a virtual environment
(e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.

### Dependencies

<!-- start deps -->

Manim Slides requires either Manim or ManimGL to be installed.
Having both packages installed is fine too.

If none of those packages are installed, please refer to their specific installation guidelines:
- [Manim](https://docs.manim.community/en/stable/installation.html)
- [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)

:::{warning}
If you install Manim from its git repository, as suggested by ManimGL,
make sure to first check out a supported version (e.g., `git checkout tags/v1.6.1`
for ManimGL), otherwise it might install an unsupported version of Manim!
See [#314](https://github.com/jeertmans/manim-slides/issues/314) for an example.
:::

<!-- end deps -->

### Pip Install

:::{note}
For an easy and safe installation, use [`pipx`](https://pipx.pypa.io/)
instead of `pip`.
:::

The recommended way to install the latest release is to use pip:

```bash
pipx install manim-slides
```

Optionally, you can also install Manim or ManimGL using extras[^1]:

```bash
pip install "manim-slides[manim]" # For Manim
# or
pip install "manim-slides[manimgl]" # For ManimGL
```

[^1]: You still need to have Manim or ManimGL platform-specific dependencies
installed on your computer.

### Install From Repository

An alternative way to install Manim Slides is to clone the git repository,
and install from there: read the
[contributing guide](https://eertmans.be/manim-slides/contributing/workflow.html)
to know how to process.

<!-- end install -->

## Creating your first slides

```{include} ../../README.md
Expand Down

0 comments on commit a5ef18b

Please sign in to comment.