marko10_000
/
apostrophe
forked from Mirrors/apostrophe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated README with building instructions

gh-pages
somas95 2018-04-11 21:28:15 +02:00
parent a7d29bf043
commit 360a8dc3d7
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -7,14 +7,30 @@ To use uberwriter, please make sure you have some dependencies installed:
- Pandoc, the program used to convert Markdown to basically anything else (the package name should be pandoc in most distributions)
- Of course, gtk3 etc. needs to be installed as well since this is a gtk application
- Please find these packages on your distribution: `python3 python3-regex python3-distutils-extra python3-levenshtein python3-enchant python3-gi python3-cairo`
- Please find these packages on your distribution: `python3 python3-regex python3-setuptools python3-levenshtein python3-enchant python3-gi python3-cairo`
You can build UberWriter with `sudo python3 setup.py build`,
and then run it with `./bin/uberwriter`
You can run UberWriter with `./bin/uberwriter`
It's also possible to build, run and debug a flatpak package. You'll need flatpak-builder for this:
- cd to the flatpak dir of the repo
- `flatpak-builder --install --force-clean some_folder_name uberwriter.json` (this installs and cleans the build folder)
- `flatpak run de.wolfvollprecht.UberWriter`
- you can also debug with the following: `flatpak-builder --run --share=network some_folder_name uberwriter.json sh`
If you can find Uberwriter after this, it's due to a Flatpak bug. Try to export it to a local repo before installing it:
- `cd flatpak`
- `flatpak-builder --repo=org.foo.Uberwriter --force-clean build uberwriter.json`
- `flatpak remote-add --no-gpg-verify user org.foo.Uberwriter`
- `flatpak install foo de.wolfvollprecht.UberWriter`
Where `org.foo.repo` is the name of your repo, you can change 'foo' with the name you want
Then you can run it as before or from your system launcher.
If you want to update an existing installation, just run
- `flatpak update de.wolfvollprecht.UberWriter`
You can also debug with the following: `flatpak-builder --run --share=network some_folder_name uberwriter.json sh`
If you want to install it using setuptools, simply run `python3 setup.py build install`