Skip to content

Commit

Permalink
Update INSTALL.md
Browse files Browse the repository at this point in the history
Added Pyglet Player to dependencies to get rid of a terminal error, and added Ubuntu 20.04 specific instructions including a workaround for issue kirienko#107.  I also added a note at the beginning that this fork is still under development.
  • Loading branch information
OzarkShepherd authored Jul 16, 2020
1 parent 0fb51fe commit 53505c8
Showing 1 changed file with 33 additions and 5 deletions.
38 changes: 33 additions & 5 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Installation
===========
We'll assume you're reading this document because you want to install Gourmet manually.
We'll assume you're reading this document because you want to install Gourmet manually. Please keep in mind that this port to Python 3 is still in development.

Required Packages
===============
Linux/Unix
----------
Fortunately for Linux and Unix users, at least most of the software Gourmet requires comes packaged with most Linux (and some Unix) distributions. The table at the bottom of this document lists the dependencies, and the corresponding packages' names for some of the more popular distros.

To install Gourmet from source -- i.e. from the tarball found at our [Releases](https://github.com/kirienko/gourmet/releases) web page -- just uncompress that tarball, cd into the resulting directory, and run `sudo python setup.py install` after installing the requirements, which will
To install Gourmet from source -- i.e. from the tarball found at our [Releases](https://github.com/kirienko/gourmet/releases) web page -- just uncompress that tarball, cd into the resulting directory, and run `sudo python3 setup.py install` after installing the requirements, which will
install gourmet to your current python environment's default location (i.e. subdirectories of `/usr/local` for most Linux distributions. For information on how to customize these locations, run
`sudo python setup.py --help`).
`sudo python3 setup.py --help`).

That should be all you need, and will create an entry in your launcher menu.
Alternatively, you can now run gourmet by issuing
Expand All @@ -23,6 +23,34 @@ Gourmet also has command line options, most of which should not be
needed by an average user. Issuing `gourmet --help` will get you help
for those options.

Ubuntu 20.04
------------
For Ubuntu 20.04 with the default Gnome desktop environment, here are specific instructions. In a terminal run the commands below to set up the dependencies.

`sudo apt update`

`sudo apt install python3-sqlalchemy python3-pil intltool python3-dogtail python3-ebooklib python3-keyring python3-lxml python3-cairo python3-enchant python3-selenium python3-reportlab python3-gtkspellcheck python3-gst-1.0 python3-pyglet python3-bs4 python3-ipython python3-pip`

`sudo pip3 install scrape-schema-recipe`

Then extract the zip file from https://github.com/kirienko/gourmet and open a terminal in the extracted directory in order to run the command below.

`sudo python3 setup.py install`

#If the application fails to launch, then run gourmet in a terminal with the command below.

`gourmet`

If you see the following error:

`gi.repository.GLib.Error: g-file-error-quark: Failed to open file "/usr/local/share/ui/preferenceDialog.ui": No such file or directory (4)`

Then the workaround is to enter the following command in terminal:

`sudo nano /usr/local/lib/python3.8/dist-packages/gourmet/settings.py`

Then change line 7 to `base_dir = '/usr/local/share/gourmet'` and try to open Gourmet again.

Mac OS X
--------
### Installing with "Automatic Installation"
Expand Down Expand Up @@ -130,7 +158,7 @@ Requirements |Ubuntu 20.04 |MacPorts
Python 3.8 |(installed) | |http://www.python.org/
GTK+ |(installed) | |
SQLAlchemy |python3-sqlalchemy | |http://www.sqlalchemy.org/download.html
Pillow 2.x (Python Imaging Library Fork) |python3-pil | |https://pypi.python.org/pypi/Pillow/
Pillow |python3-pil | |https://pypi.python.org/pypi/Pillow/
elib.intl | | |http://github.com/dieterv/elib.intl/zipball/master
*Build Requirements* | | |
setuptools (*Windows only!*) | | |
Expand All @@ -140,7 +168,6 @@ Python Dogtail |python3-dogtail |
Python eBook |python3-ebooklib | |
Python Keyring |python3-keyring | |
Python LXML |python3-lxml | |
Pillow |python3-pil | |
PyCairo |python3-cairo | |
PyEnchant |python3-enchant | |
pygobject | | |
Expand All @@ -150,6 +177,7 @@ Python Reportlab (for printing/PDF export) |python3-reportlab |
pypoppler (for printing and PDF export) | | |
PyGTKSpell (for the spell checking plugin) |python3-gtkspellcheck | |(N/A)
python3-gst-1.0 (for sound) |python3-gst-1.0 | |*not required*
Pyglet Player (for sound) |python3-pyglet | |
BeautifulSoup (for the Web import plugin) |python3-bs4 | |http://www.crummy.com/software/BeautifulSoup/#Download
IPython (interactive shell plugin) |python3-ipython | |https://pypi.python.org/pypi/ipython/0.12.1#downloads
*Windows only* | | |
Expand Down

0 comments on commit 53505c8

Please sign in to comment.