-
Notifications
You must be signed in to change notification settings - Fork 101
Feature Request: Added documentation for installation of graphicsmagick #455
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.
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
base: develop
Are you sure you want to change the base?
Conversation
@U8NWXD could you PTAL here. |
* [Notes on installation on Arch Linux systems](#notes-on-installation-on-arch-linux-systems) | ||
* [Changes to installation prerequisites](#changes-to-installation-prerequisites) | ||
* [Changes to the virtual environment setup](#changes-to-the-virtual-environment-setup) | ||
- [Table of Contents](#table-of-contents) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We exclude the table of contents entry from the table of contents
- For MacOS: | ||
``` | ||
brew install graphicsmagick | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The macOS installation instructions should go in our separate macOS installation guide
3. Install GraphicsMagick to enable local image compression and ensure tests run successfully. Follow the appropriate steps below based on your operating system: | ||
- For Ubuntu/Debian systems: | ||
``` | ||
sudo apt-get update | ||
sudo apt-get install graphicsmagick | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why not just add graphicsmagick to the packages installed in step 1 and to scripts/install_prerequisites.sh
? that seems simpler
After installation, verify that GraphicsMagick is correctly installed by running: | ||
``` | ||
gm version | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can skip this, as we don't confirm installation of any of our other prerequisites. Dropping this will also let you more easily fold this change into step 1
Added documentation for installation of graphicsmagick, which is discussed in this oppia/oppia#21694 PR several times.
In this PR I added installation steps for linux and mac users only. I'll add installation steps for windows soon.
Thanks.