From 9316f2ba90bdf68a45562ebe13fd7d8ad69d7c8a Mon Sep 17 00:00:00 2001 From: Bryan Weber Date: Sat, 29 Apr 2023 19:46:42 -0400 Subject: [PATCH 1/2] Suggestions for paper --- paper/paper.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/paper/paper.md b/paper/paper.md index f19bad3a..6aa4841d 100644 --- a/paper/paper.md +++ b/paper/paper.md @@ -64,7 +64,7 @@ provide new features on a regular basis. # 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 graphical user interface (GUI), or shared via HTML thanks to the RevealJS Javascript package [@revealjs]. @@ -92,8 +92,8 @@ and posted it on YouTube. # Stability and releases 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 -Slide's exposed API begin very minimal, and the variaty of tests that are +and ManimGL, and on all major platforms: **Ubuntu**, **macOS** and **Windows**. Due to Manim +Slide's exposed API being very minimal, and the variety of tests that are performed, this tool can be considered stable over time. 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 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. Finally, we also acknowledge contributions from the GitHub contributors on the From 9c1fdbfdb2fa54d4385e7e92977b379cb221692e Mon Sep 17 00:00:00 2001 From: Bryan Weber Date: Sat, 29 Apr 2023 19:52:17 -0400 Subject: [PATCH 2/2] A few suggestions for the documentation --- docs/source/reference/api.md | 2 +- docs/source/reference/html.md | 2 +- docs/source/reference/sharing.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/reference/api.md b/docs/source/reference/api.md index 6cc19c79..7c6a5863 100644 --- a/docs/source/reference/api.md +++ b/docs/source/reference/api.md @@ -1,6 +1,6 @@ # 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. diff --git a/docs/source/reference/html.md b/docs/source/reference/html.md index ba58f842..01c21869 100644 --- a/docs/source/reference/html.md +++ b/docs/source/reference/html.md @@ -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 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: ```bash diff --git a/docs/source/reference/sharing.md b/docs/source/reference/sharing.md index 3a43c0b7..c44f739f 100644 --- a/docs/source/reference/sharing.md +++ b/docs/source/reference/sharing.md @@ -67,7 +67,7 @@ and the corresponding tree: ## Without Manim Slides installed on the target machine 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 [Feature Request](https://github.com/jeertmans/manim-slides/issues/new/choose), or directly proposing a