README.md

   1 ###VYM - View Your Mind (c) 2004-2017 by Uwe Drechsel###
   2
   3 Documentation
   4 -------------
   5
   6 * PDF
   7
   8     The complete documentation of vym is available as PDF document in
   9     english and spanish. (The spanish version is not really up to date,
  10     translators are welcome). It can be accessed directly from vym via
  11     the help section It also can be downloaded from the vym site at
  12     Sourceforge:
  13
  14         https://sourceforge.net/projects/vym/
  15
  16 * Screencasts
  17
  18     There are several screencasts available on YouTube, which show some
  19     feature of vym and how to use them:
  20
  21         http://www.youtube.com/user/ViewYourMind
  22
  23
  24 Download
  25 --------
  26
  27 The official downloads for all platforms are available at the project
  28 site:
  29
  30         https://sourceforge.net/projects/vym/
  31
  32 The latest binaries for Linux (currently mainly openSUSE) are found in the
  33 Open Build Service project of Uwe Drechsel (aka insilmaril):
  34
  35     http://download.opensuse.org/repositories/home%3A//insilmaril/
  36
  37
  38
  39 Installation
  40 ------------
  41
  42 * Binaries
  43
  44     Installation depends on the platform you use, please check the
  45     homepage for details:
  46
  47         http://www.insilmaril.de/vym
  48
  49 * Compiling
  50
  51     Compiling vym from scratch is pretty easy, if you have the
  52     development packages of the Qt5 toolkit installed. (Check also the
  53     homepage above for details):
  54
  55     qmake
  56     make
  57     make install
  58
  59 * Testing (without installing!)
  60
  61     You can also run vym virtually in your webbrowser: vym is available
  62     as appliance in SUSE Studio. SUSE Studio is a very easy way to
  63     create appliances, which are customized Linux operating systems.
  64
  65     All you need is to quickly create a free account and search for
  66     "vym" by user "insilmaril" in the gallery:
  67
  68         http://susestudio.com
  69
  70     The appliance can be downloaded as installable iso image, or run in
  71     the testdrive - in your webbrowser! That's a bit slow, but gives you
  72     an idea without having to install anything at all on your system.
  73
  74
  75 Questions and feedback
  76 ----------------------
  77
  78 Please direct questions to the mailinglist first:
  79
  80     vym-forum@lists.sourceforge.net
  81
  82
  83