Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Suggestions from JOSE review #168

Merged
merged 2 commits into from
May 1, 2023
Merged

Suggestions from JOSE review #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9316f2b
Suggestions for paper
bryanwweber Apr 29, 2023
9c1fdbf
A few suggestions for the documentation
bryanwweber Apr 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/reference/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/reference/html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/reference/sharing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions paper/paper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down