opensource/manim-slides
1
0
Fork 0
mirror of https://github.com/jeertmans/manim-slides.git synced 2025-05-20 03:57:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(paper): suggestions from JOSE review (#168)

Browse Source 
* Suggestions for paper

* A  few suggestions for the documentation
This commit is contained in:
Bryan Weber
2023-05-01 05:06:55 -04:00
committed by GitHub
parent bce4d8188f
commit 8b13106fcc
4 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/reference/api.md
View File

@ -1,6 +1,6 @@
# Application Programming Interface # Application Programming Interface
Manim Slides' API is very limited: it simply consists in two classes, `Slide` and `ThreeDSlide`, which are subclasses of `Scene` and `ThreeDScene` from Manim. Manim Slides' API is very limited: it simply consists of two classes, `Slide` and `ThreeDSlide`, which are subclasses of `Scene` and `ThreeDScene` from Manim.
Thefore, we only document here the methods we think the end-user will ever use, not the methods used internally when rendering. Thefore, we only document here the methods we think the end-user will ever use, not the methods used internally when rendering.

2
docs/source/reference/html.md
View File

@ -4,7 +4,7 @@ Manim Slides allows you to convert presentations into one HTML file, with
[RevealJS](https://revealjs.com/). This file can then be opened with any modern [RevealJS](https://revealjs.com/). This file can then be opened with any modern
web browser, allowing for a nice portability of your presentations. web browser, allowing for a nice portability of your presentations.
As for every command with Manim Slides, converting slides' fragments into one As with every command with Manim Slides, converting slides' fragments into one
HTML file (and its assets) can be done in one command: HTML file (and its assets) can be done in one command:
```bash ```bash

2
docs/source/reference/sharing.md
View File

@ -67,7 +67,7 @@ and the corresponding tree:
## Without Manim Slides installed on the target machine ## Without Manim Slides installed on the target machine
An alternative to `manim-slides present` is `manim-slides convert`. An alternative to `manim-slides present` is `manim-slides convert`.
Currently, only HTML conversion is available, but do not hesitate to propose Currently, HTML and PPTX conversion are available, but do not hesitate to propose
other formats by creating a other formats by creating a
[Feature Request](https://github.com/jeertmans/manim-slides/issues/new/choose), [Feature Request](https://github.com/jeertmans/manim-slides/issues/new/choose),
or directly proposing a or directly proposing a

8
paper/paper.md
View File

@ -64,7 +64,7 @@ provide new features on a regular basis.
# Easy to Use Commitment # Easy to Use Commitment
Manim Slides is commited to be an easy-to-use tool, when minimal installation Manim Slides is commited to be an easy-to-use tool, with minimal installation
procedure and few modifications required. It can either be used locally with its procedure and few modifications required. It can either be used locally with its
graphical user interface (GUI), or shared via HTML thanks to the RevealJS graphical user interface (GUI), or shared via HTML thanks to the RevealJS
Javascript package [@revealjs]. Javascript package [@revealjs].
@ -92,8 +92,8 @@ and posted it on YouTube.
# Stability and releases # Stability and releases
Manim Slides is continously tested on most recent Python versions, both ManimCE Manim Slides is continously tested on most recent Python versions, both ManimCE
and ManimGL, and on all major platforms: **Ubuntu**, **macOS** and **Windows**. As of Manim and ManimGL, and on all major platforms: **Ubuntu**, **macOS** and **Windows**. Due to Manim
Slide's exposed API begin very minimal, and the variaty of tests that are Slide's exposed API being very minimal, and the variety of tests that are
performed, this tool can be considered stable over time. performed, this tool can be considered stable over time.
New releases are very frequent, as they mostly introduce enhancements or small New releases are very frequent, as they mostly introduce enhancements or small
@ -116,7 +116,7 @@ how to actually present them efficiently.
We acknowledge the work of [@manim-presentation] that paved the initial structure We acknowledge the work of [@manim-presentation] that paved the initial structure
of Manim Slides with the manim-presentation Python package. of Manim Slides with the manim-presentation Python package.
We also acknowledge Grant Sanderson for its termendous work on Manim, as well as We also acknowledge Grant Sanderson for his tremendous work on Manim, as
well as the Manim Community contributors. well as the Manim Community contributors.
Finally, we also acknowledge contributions from the GitHub contributors on the Finally, we also acknowledge contributions from the GitHub contributors on the