= Skavegra: README file =

Skavegra 0.1.0 is a simple work-in-progress SVG (Scalable Vector Graphics)
image viewer. Any SVG image should work, but SVG Tiny 1.2 images are
currently preferred. But even SVG Tiny 1.2 isn't fully implemented yet.

Please note that Skavegra is still in a very early stage, so expect
errors. Don't rely on this tool (yet) for accurate renderings.

The aim of this project is to provide a quick, simple, yet useful
SVG viewing tool with a small but complete (in terms of implementing
the SVG Tiny 1.2 standard) feature set.

== Skavegra overview ==
- Name: Skavegra
- Preferred pronounciation: /ska.ˈve.graʕ/
- Current version: 0.1.0
- Skavegra is free software, please copy and share! :-)

== Features overview ==
- Opening SVG 1.2 Tiny documents (partial support; full support is planned)
- Opening SVG 1.1 documents (partial support)
- Opening compressed SVG images (“.svg.gz”, “.svgz”)
- Displaying SVG metadata such as title and description
- Zooming and panning
- Simple keyboard shortcuts for every feature
- German translation (automatically enabled on German systems)

== Compiling the source code ==
Note that these instructions have NOT been well-tested yet.
If any of these instructions don't seem to work for you,
please contact <almikes@aol.com> (e-mail).

=== Qt Creator ===
If you have Qt Creator and Qt 5.5 installed, you should be able
to import this project by using the Skavegra.pro file as project.
Just hit the “Run” or “Compile” button and it should work out of
the box.

=== GNU/Linux ===
1) Make sure to install all dependencies. Install:
- Qt 5.5 or later
- GNU make
- A C++ compiler for your system
	- Try the GNU compiler collection (for the g++ compiler)

2) Invoke a command line tool like bash
3) Change the working directory in which this README file is located
4) Invoke “qmake Skavegra.pro”
5) Invoke “make”

Now you should have an executable program called “skavegra” in your working
directory.
Execute it to start Skavegra.

If you want to install Skavegra system-wide, one extra step is required:

6) Invoke “make install” (might require super-user rights)

If you have a modern desktop system installed (e.g. KDE, GNOME, XFCE, etc.),
you now should find Skavegra in your “Applications” (or similar) menu in
the Graphics category (and possibly some related ones, too).
You can also invoke Skavegra from the command-line with “skavegra”.

=== Other systems ===
Sorry, you're on your own. If you managed to compile this software on other
systems successfully, please send your instructions in an e-mail to:

<almikes@aol.com>



== License ==
Skavegra itself is licensed under the WTFPL, which means no restrictions apply.
See the file “LICENSE” for the full license text.

Skavegra makes use of the Qt libraries, which are licensed under LGPLv3 and
LGPLv2.1.
See https://qt.io/ for more information about Qt.