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

Updated README to reflect building changes 

Signed-off-by: somas95 <manuel.genoves@gmail.com>
gh-pages
somas95 2018-04-05 13:27:05 +02:00
parent 426b954c3d
commit 08ba958fcc
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -6,8 +6,15 @@ Uberwriter is a GTK+ based distraction free Markdown editor, mainly developed by
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)
- Use pip to install python dependencies: `sudo pip3 install -r requirements.txt`
- 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`
It should be possible to install UberWriter with `sudo python3 setup.py install --root=/`
You can build UberWriter with `sudo python3 setup.py build`,
and then run it 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