README.md 3.03 KB
Newer Older
Manuel Genovés's avatar
Manuel Genovés committed
1
2
[![Please do not theme this app](https://stopthemingmy.app/badge.svg)](https://stopthemingmy.app)

3
# Apostrophe
Wolf Vollprecht's avatar
Wolf Vollprecht committed
4

Manuel Genovés's avatar
Manuel Genovés committed
5
6
![](screenshots/main.png)

Manuel Genovés's avatar
Manuel Genovés committed
7
## About
8

Manuel Genovés's avatar
v2.6    
Manuel Genovés committed
9
Apostrophe is a [GTK+](https://www.gtk.org) based distraction free Markdown editor, originally developed by Wolf Vollprecht and currently developed and maintained by Manuel Genovés. It uses pandoc as back-end for parsing Markdown and offers a very clean and sleek user interface.
10

Manuel Genovés's avatar
Manuel Genovés committed
11
## Install
Manuel Genovés's avatar
Manuel Genovés committed
12

13
<a href='https://flathub.org/apps/details/org.gnome.gitlab.somas.Apostrophe'><img width='240' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'/></a>
Manuel Genovés's avatar
Manuel Genovés committed
14

15
Also several unofficial builds are available:
Manuel Genovés's avatar
Manuel Genovés committed
16

17
* Nix(OS): [`pkgs.apostrophe`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/apostrophe/default.nix)
18
* Arch Linux (AUR)
19
* [Fedora](https://src.fedoraproject.org/rpms/apostrophe): `sudo dnf install apostrophe`
Manuel Genovés's avatar
Manuel Genovés committed
20

21
## Translation
22

Manuel Genovés's avatar
Manuel Genovés committed
23
If you want to help translating the project, please join us at [Damned Lies](https://l10n.gnome.org/module/apostrophe/).
24
25
Any help is appreciated!

26
## Building
Manuel Genovés's avatar
Manuel Genovés committed
27

28
### Building using GNOME Builder
Manuel Genovés's avatar
Manuel Genovés committed
29

30
GNOME Builder offers the easiest method to build Apostrophe. Just follow [this guide](https://wiki.gnome.org/Newcomers/BuildProject) and you'll be up and running in a minute.
31
32

### Building from Git
Manuel Genovés's avatar
Manuel Genovés committed
33

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
To build Apostrophe from source you need to have the following dependencies installed:

- Build system: `meson ninja-build`
- Pandoc, the program used to convert Markdown to basically anything else: `pandoc`
- GTK3 and GLib development packages: `libgtk-3-dev libglib2.0-dev`
- Rendering the preview panel: `libwebkit2gtk`
- Spell checking libraries: `gobject-introspection libgirepository1.0-dev gir1.2-gspell1 gettext`
- Python dependencies: `python3 python3-regex python3-setuptools python3-levenshtein python3-enchant python3-gi python3-cairo python3-pypandoc`
- *optional:* AppStream utility: `appstream-util`
- *optional:* pdftex module: `texlive texlive-latex-extra`
- *optional:* formula preview: `libjs-mathjax`

Depending on your setup you may need to install these schemas before building:

```bash
$ sudo cp data/org.gnome.gitlab.somas.Apostrophe.gschema.xml /usr/share/glib-2.0/schemas/org.gnome.gitlab.somas.Apostrophe.gschema.xml
$ sudo glib-compile-schemas /usr/share/glib-2.0/schemas
```

Once all dependencies are installed you can build Apostrophe using the following commands:
Manuel Genovés's avatar
Manuel Genovés committed
54
55

```bash
Manuel Genovés's avatar
Manuel Genovés committed
56
$ git clone https://gitlab.gnome.org/World/apostrophe/
57
$ cd apostrophe
58
59
60
61
62
63
64
65
66
67
68
69
70
$ meson builddir --prefix=/usr -Dprofile=development
$ sudo ninja -C builddir install
```

Then you can run the installed package:

```bash
$ apostrophe
```

Or a local version which runs from the source tree
```bash
$ ./builddir/local-apostrophe
Manuel Genovés's avatar
Manuel Genovés committed
71
```
72

73

74

Manuel Genovés's avatar
Manuel Genovés committed
75
### Building a flatpak package
76

77
It's also possible to build, run and debug a flatpak package. All you need is to setup [flatpak-builder](https://docs.flatpak.org/en/latest/first-build.html) and run the following commands:
78

Manuel Genovés's avatar
Manuel Genovés committed
79
80
```bash
$ cd build-aux/flatpak
81
$ flatpak-builder --force-clean --install --user _build org.gnome.gitlab.somas.Apostrophe.json
Manuel Genovés's avatar
Manuel Genovés committed
82
```