Install doc #586
Merged
Install doc #586
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
June 11, 2019 00:49
Env Var used in the compose.yml is INPUT_DIR and OUTPUT_DIR Clarify the meaning of both variables and output message. Note on -p not working.
eulertour
requested changes
Jun 13, 2019
README.md
Outdated
| docker-compose run manim example_scenes.py SquareToCircle -l | ||
| ``` | ||
| The command needs to be run as root if your username is not in the docker group. | ||
|
|
||
| example_scenes.py or your own project should point to the file on the host machine. |
There was a problem hiding this comment.
I'm not sure what you mean by "pointing" to a file here.
There was a problem hiding this comment.
maybe should be path to files?
|
I wrote those documentations base on the assumption that the code is always correct and that the doc should reflect whatever is written. |
added 3 commits
June 15, 2019 00:43
Change all refernces of INPUT_DIR to INPUT_PATH change all references of OUTPUT_DIR to OUTPUT_PATH change a paragraph
|
I added a diagram for the docker setup, should be more clear |
eulertour
reviewed
Jun 15, 2019
README.md
Outdated
| environment variable to the directory containing your source code and the | ||
| `OUTPUT_DIRECTORY` environment variable to the directory where you want media | ||
| to be written. | ||
| environment variable to the directory containing manim repository and the |
There was a problem hiding this comment.
Manim is now stored inside the docker image, so INPUT_PATH should be the absolute path to the directory containing the source code.
README.md
Outdated
| docker-compose run manim example_scenes.py SquareToCircle -l | ||
| ``` | ||
| The command needs to be run as root if your username is not in the docker group. | ||
|
|
||
| replace `example_scenes.py` with your own on the host machine for your projects. |
There was a problem hiding this comment.
"You can replace example_scenes.py with any relative path from your INPUT_PATH"
|
Did the pr slip through the notification? |
eulertour
pushed a commit
to eulertour/manim-3b1b
that referenced
this pull request
Nov 16, 2020
* Clean up README * update flags * Apply suggestions from code review * updated command.png * removed redundant files from readme-asserts and used files from docs/_static instead * change to relative parts Co-authored-by: Leo Torres <[email protected]> Co-authored-by: kolibril13 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Env Var used in the compose.yml is INPUT_DIR and OUTPUT_DIR
Clarify the meaning of both variables and output message.
Note on -p not working.