aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFelix (xq) Queißner <git@mq32.de>2020-06-09 00:19:32 +0200
committerFelix (xq) Queißner <git@mq32.de>2020-06-09 00:19:32 +0200
commitdf4fbcb4cf6c593c725f677b2ed587e877ae6709 (patch)
treee399602df5bd4bd240b8746ff45dee13cc6ebd53 /README.md
parent573e73eb1b7a4b5f1cc7037feab620ad9c077f2d (diff)
downloadkristall-df4fbcb4cf6c593c725f677b2ed587e877ae6709.tar.gz
Adds help document, adds block quote support, updates gemini parser to newest spec, adds support for arbitrary gemini files in about: space, adds url bar shortcut, fixes bug with line breaks in preformatted text
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 15 insertions, 6 deletions
diff --git a/README.md b/README.md
index c0aeddc..ab1a1a9 100644
--- a/README.md
+++ b/README.md
@@ -44,7 +44,7 @@ A high-quality visual cross-platform gemini browser.
![Site Theme](https://mq32.de/public/7123e22a58969448c27b24df8510f4d56921bf23.png)
-## Build Instructions
+## Build/Install Instructions
### Requirements
@@ -52,7 +52,7 @@ A high-quality visual cross-platform gemini browser.
### Build
-## *nix
+#### *nix
There's a small `Makefile` provided that does all necessary steps and creates a build directory, then copies the build artifact from the build directory. Just do `make` in the root directory, it should work.
@@ -69,7 +69,7 @@ make
- It seems like Qt wants `libzstd.so.3.1` instead of `libzstd.so.3.2`. Just symlink that file into the build directory
- Use `make` and not `gmake` to build the project.
-### Notes for Ubuntu 20.04:
+##### Notes for Ubuntu 20.04:
- Requires packages
- `qt5-default`
- `qt5-qmake`
@@ -77,18 +77,27 @@ make
- `make`
- `g++`
-### Notes for Manjaro/Arch
+##### Notes for Manjaro/Arch
- Requires packages
- `qt5`
- `qt5-multimedia`
-### Notes on void linux
+##### Notes on void linux
- set env variable `QT_SELECT=5`
-## Windows
+#### Windows
Just use QtCreator to build `./src/kristall.pro`. Default settings should be fine.
+### Manual Installation
+
+#### Unix / XDG
+
+The provided desktop file can be installed into the local system
+```sh
+ln -s Kristall.desktop ~/.local/share/applications/kristall.desktop
+```
+
## TODO
- [ ] Survive full torture suite
- [ ] Correctly parse mime parameters