README.md

Yuml Recipes

This is the GNOME application for Yuml Recipes. It opens *.yuml files by registering the application/x-yuml mimetype. Internally it uses the Yuml Recipes Python Library.

Preview

See the corresponding 'Chili con Carne.yuml' file.

Installation

Install from GitHub release

1. Download the org.yumlrecipes.yumlrecipes.flatpak file from the latest release in GitHub
2. Run flatpak install --user org.yumlrecipes.yumlrecipes.flatpak

Install from sources

1. Clone this repository
2. Run ./run to install and start the application

Roadmap

• Support for *.yuml files packaged with their images as ZIP file keeping the *.yuml extension
  • Export thumbnailer to give the zipped_recipe.yuml the thumbnail of its image, see Flatpak thumbnailer feature request

Hints

Manage mimetype from console

• Run xdg-open filename.yuml to run and get console output
• Run xdg-mime default org.yumlrecipes.yumlrecipes.desktop application/x-yuml to set as default

Important locations for development

• ~/.local/share/flatpak/exports/share
• ~/.local/share/flatpak/exports/share/applications
• ~/.local/share/flatpak/exports/share/mime/packages
• /var/lib/flatpak/exports/share
• /var/lib/flatpak/exports/share/applications
• /var/lib/flatpak/exports/share/mime/packages

Links

• GTK 3 Python Reference
• GTK 3 How Do I
• GTK 4 Widget Documentation
• GNOME Integration
• Flatpak PIP Generator
• Flatpak CI Docker Image

License

GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007

GPL-3.0

Copyright (c) 2023 Patrick Eschenbach