diff --git a/INSTALL.md b/INSTALL.md index c34a7663..eb426cf7 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,45 +1,49 @@ # Installation -Gourmet is currently available in the form of Flatpak, AppImage, and Python wheel. -We recommend that you install it from the Flatpak. -For wheels and Flatpak installations, you will need an internet connection. The AppImage can be copied. + +Gourmet is currently available in the form of Flatpak, AppImage, and Python wheel. +For wheels and Flatpak installations, you will need an internet connection. +The AppImage can be copied from one computer to another. ## AppImage -Gourmet is tentatively packaged as an AppImage. -This means that we're evaluating AppImages for the long run, but you may encounter some issues. -Please report any problems! -The AppImage is available from the [release page](https://github.com/kirienko/gourmet/releases/tag/v1.0.0-rc2). -Download the AppImage and mark it as executable: +The AppImage is available from the [release page](https://github.com/kirienko/gourmet/releases/tag/v1.0.0). +Download the it and mark it as executable: + ```sh -chmod +x Gourmet-cb604da9.AppImage +chmod +x ./Gourmet-1.0.0-x86_64.AppImage ``` It can then be executed by double-clicking on it or launching it from a terminal: + ```sh -./Gourmet-cb604da9.AppImage +./Gourmet-1.0.0-x86_64.AppImage ``` ## Flatpak + The Flatpak contains the full environment, but depends on other flatpak packages, which will be installed automatically. Install Flatpak if it's not on your system already: + ```sh sudo apt-get install flatpak ``` As Gourmet is still under active development, the flatpak is not available from -Flathub, and instead must be [downloaded and installed manually](https://github.com/kirienko/gourmet/releases/tag/v1.0.0-rc2). +Flathub, and instead must be [downloaded and installed manually](https://github.com/kirienko/gourmet/releases/tag/v1.0.0). In a terminal, execute the following: + ```sh flatpak remote-add --if-not-exists --user flathub https://flathub.org/repo/flathub.flatpakrepo -sudo flatpak install gourmet-cb604da9.flatpak +sudo flatpak install gourmet-1.0.0.flatpak ``` You will be prompted with a message regarding the runtime: + ```sh -Required runtime for io.github.thinkle.Gourmet/x86_64/master (runtime/org.gnome.Platform/x86_64/3.36) found in remote flathub) +Required runtime for io.github.thinkle.Gourmet/x86_64/master (runtime/org.gnome.Platform/x86_64/3.40) found in remote flathub) Do you want to install it? [Y/n] ``` @@ -48,24 +52,26 @@ them all. At the end, you will be greeted with an `Installation complete.` message. -You can now launch the Flatpak either from your application menu or from the +You can now launch the Flatpak either from your application menu, or from the command line so: + ```sh flatpak run io.github.thinkle.Gourmet ``` It can be uninstalled so: + ```sh flatpak remove io.github.thinkle.Gourmet ``` - ## Python Wheel -[Download the wheel](https://github.com/kirienko/gourmet/releases/tag/v1.0.0-rc2) +[Download the wheel](https://github.com/kirienko/gourmet/releases/tag/v1.0.0) Dependencies must be manually installed. ### Unbutu 20.04, Linux Mint 20 + Install the following packages from `apt`: ```sh @@ -74,40 +80,44 @@ sudo apt-get update sudo apt-get install --no-install-recommends python3-gi python3-gi-cairo gir1.2-gtk-3.0 libgirepository1.0-dev libcairo2-dev enchant python3-bs4 python3-ebooklib python3-keyring python3-lxml python3-pil python3-cairo python3-enchant python3-gi python3-gst-1.0 python3-gtkspellcheck python3-requests python3-reportlab python3-selenium python3-setuptools python3-sqlalchemy python3-pip python3-toml gir1.2-poppler-0.18 ``` -Then, install dependencies from the Python repository: -```sh -sudo pip3 install scrape-schema-recipe -``` - Finally, install Gourmet: ```sh -sudo pip3 install gourmet-cb604da9-py3-none-any.whl +sudo pip3 install gourmet-1.0.0-py3-none-any.whl ``` You can now launch Gourmet from a terminal: ```sh $ gourmet +First time? Setting you up with yummy recipes. ``` ## Windows 10 -Running Gourmet on Windows is still experimental at this stage: the application can run fine, and even export to PDF. However, there are a couple of issues, and the installation is cumbersome. +Running Gourmet on Windows is still experimental at this stage: the application can run fine, and even exports to PDF. However, there are a couple of issues, and the installation is cumbersome. Download and install [MSYS2](https://www.msys2.org/) Within the MSYS2 terminal, synchronize your software sources: +```sh pacman -Syu +``` Then install some of the dependencies: +```sh pacman -S mingw-w64-x86_64-gtk3 mingw-w64-x86_64-python3-gobject mingw-w64-x86_64-python-pillow mingw-w64-x86_64-python-sqlalchemy mingw-w64-x86_64-gstreamer mingw-w64-x86_64-poppler mingw-w64-x86_64-python-reportlab +``` -[Download the wheel](https://github.com/kirienko/gourmet/releases/tag/v1.0.0-rc2) and install it: +[Download the wheel](https://github.com/kirienko/gourmet/releases/tag/v1.0.0) and install it: - python3 -m pip install gourmet-cb604da9-py3-none-any.whl +```sh + python3 -m pip install gourmet-1.0.0-py3-none-any.whl +``` Then launch it: +```sh python3 -m gourmet +``` diff --git a/setup.py b/setup.py index 85e83967..70e71853 100644 --- a/setup.py +++ b/setup.py @@ -197,7 +197,7 @@ def run(self): 'spellcheck': ['pyenchant', 'pygtkspellcheck'], 'web-import': ['keyring==21.0.0', - 'scrape-schema-recipe==0.1.3', + 'scrape-schema-recipe==0.1.5', 'selenium==3.141.0'], }, cmdclass={