README

   1 = Skavegra: README file =
   2
   3 Skavegra 0.1.0 is a simple work-in-progress SVG (Scalable Vector Graphics)
   4 image viewer. Any SVG image should work, but SVG Tiny 1.2 images are
   5 currently preferred. But even SVG Tiny 1.2 isn't fully implemented yet.
   6
   7 Please note that Skavegra is still in a very early stage, so expect
   8 errors. Don't rely on this tool (yet) for accurate renderings.
   9
  10 The aim of this project is to provide a quick, simple, yet useful
  11 SVG viewing tool with a small but complete (in terms of implementing
  12 the SVG Tiny 1.2 standard) feature set.
  13
  14 == Skavegra overview ==
  15 - Name: Skavegra
  16 - Preferred pronounciation: /ska.ˈve.graʕ/
  17 - Current version: 0.1.0
  18 - Skavegra is free software, please copy and share! :-)
  19
  20 == Features overview ==
  21 - Opening SVG 1.2 Tiny documents (partial support; full support is planned)
  22 - Opening SVG 1.1 documents (partial support)
  23 - Opening compressed SVG images (“.svg.gz”, “.svgz”)
  24 - Displaying SVG metadata such as title and description
  25 - Zooming and panning
  26 - Simple keyboard shortcuts for every feature
  27 - German translation (automatically enabled on German systems)
  28
  29 == Compiling the source code ==
  30 Note that these instructions have NOT been well-tested yet.
  31 If any of these instructions don't seem to work for you,
  32 please contact <almikes@aol.com> (e-mail).
  33
  34 === Qt Creator ===
  35 If you have Qt Creator and Qt 5.5 installed, you should be able
  36 to import this project by using the Skavegra.pro file as project.
  37 Just hit the “Run” or “Compile” button and it should work out of
  38 the box.
  39
  40 === GNU/Linux ===
  41 1) Make sure to install all dependencies. Install:
  42 - Qt 5.5 or later
  43 - GNU make
  44 - A C++ compiler for your system
  45         - Try the GNU compiler collection (for the g++ compiler)
  46
  47 2) Invoke a command line tool like bash
  48 3) Change the working directory in which this README file is located
  49 4) Invoke “qmake Skavegra.pro”
  50 5) Invoke “make”
  51
  52 Now you should have an executable program called “skavegra” in your working
  53 directory.
  54 Execute it to start Skavegra.
  55
  56 If you want to install Skavegra system-wide, one extra step is required:
  57
  58 6) Invoke “make install” (might require super-user rights)
  59
  60 If you have a modern desktop system installed (e.g. KDE, GNOME, XFCE, etc.),
  61 you now should find Skavegra in your “Applications” (or similar) menu in
  62 the Graphics category (and possibly some related ones, too).
  63 You can also invoke Skavegra from the command-line with “skavegra”.
  64
  65 === Other systems ===
  66 Sorry, you're on your own. If you managed to compile this software on other
  67 systems successfully, please send your instructions in an e-mail to:
  68
  69 <almikes@aol.com>
  70
  71
  72
  73 == License ==
  74 Skavegra itself is licensed under the WTFPL, which means no restrictions apply.
  75 See the file “LICENSE” for the full license text.
  76
  77 Skavegra makes use of the Qt libraries, which are licensed under LGPLv3 and
  78 LGPLv2.1.
  79 See https://qt.io/ for more information about Qt.