Go to file

Christopher Davis 15c69190d8 gitignore: Add generated folders These folders are not tracked by us and thus should be ignored. Prevents them from accidentally being added.		2019-04-22 18:37:43 -04:00
bin	v2.2.0-beta1 install scripts	2019-04-17 21:34:49 +02:00
data	Cap preview width similar to GitHub	2019-04-21 01:50:49 +01:00
flatpak	update flatpak json	2019-04-19 14:02:57 +02:00
help	Make advanced options match defaults, fix capitalization/typos	2019-04-15 02:50:14 +01:00
po	update localizations	2019-03-10 02:19:28 +01:00
screenshots	New mockups	2018-07-17 12:51:45 +02:00
scripts	Add script used to generate theme colors	2019-03-26 15:09:21 +00:00
tests	initial commit sidebar	2014-07-06 22:35:24 +02:00
uberwriter	Set text view padding in Python instead of CSS	2019-04-21 01:50:49 +01:00
.gitignore	gitignore: Add generated folders	2019-04-22 18:37:43 -04:00
AUTHORS	initial commit sidebar	2014-07-06 22:35:24 +02:00
COPYING	initial commit sidebar	2014-07-06 22:35:24 +02:00
ISSUE_TEMPLATE.md	Create ISSUE_TEMPLATE.md	2018-04-10 14:55:40 +02:00
Makefile	update makefile to setuptools	2018-04-11 13:47:47 +02:00
PKGBUILD	updated version	2018-11-28 22:26:31 +01:00
README.md	Update README	2018-05-20 14:28:50 +02:00
autogen.sh	make them executable	2018-11-29 23:06:59 +01:00
configure	make them executable	2018-11-29 23:06:59 +01:00
lipsum.md	update webpage	2018-06-12 20:24:40 +02:00
markdown_test.md	initial commit sidebar	2014-07-06 22:35:24 +02:00
requirements.txt	Introduce pypandoc for pandoc calls	2019-04-15 02:50:05 +01:00
setup.py	print correct folders	2019-04-19 14:39:06 +02:00
uberwriter.in	moving files to better suited folders	2019-04-01 21:29:29 +02:00

README.md

Uberwriter

About

Uberwriter is a GTK+ based distraction free Markdown editor, mainly developed by Wolf Vollprecht. It uses pandoc as backend for markdown parsing and offers a very clean and sleek user interface.

Install

You can get now UberWriter on Flathub! Get it now

Contributions and localization

If you want to help to localize the project, just join us at Poeditor Any help is appreciated!

Running and building it

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
webkit2gtk is also needed for the preview panel
Please find these packages on your distribution: python3 python3-regex python3-setuptools python3-levenshtein python3-enchant python3-gi python3-cairo
Optional dependencies are texlive for the pdftex module.

You can run UberWriter with ./bin/uberwriter without installing it in the system, but you'll need to install and compile the schemas before: sudo cp data/de.wolfvollprecht.UberWriter.gschema.xml /usr/share/glib-2.0/schemas/de.wolfvollprecht.UberWriter.gschema.xml sudo glib-compile-schemas /usr/share/glib-2.0/schemas

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

If you can't 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 it 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