README.md

   1 VYM - View Your Mind (c) 2004-2023 by Uwe Drechsel
   2 ==================================================
   3
   4 Documentation
   5 -------------
   6
   7 * PDF
   8
   9     The complete documentation of vym is available as PDF document in
  10     English, French and Spanish. (Only the English version is really up
  11     to date, translators are welcome). PDFs can be accessed directly from
  12     vym via the help section. They also can be downloaded from github at
  13
  14     https://github.com/insilmaril/vym/tree/develop/doc
  15
  16 * Screencasts
  17
  18     There are several screencasts available on YouTube, which show some
  19     features 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 development drops can be found in the Files/Development folder there.
  33
  34 The latest binaries for Linux, Debian and Ubuntu are built and available in the authors
  35 Open Build Service project:
  36
  37 https://software.opensuse.org/download.html?project=home%3Ainsilmaril&package=vym
  38
  39
  40 Source code
  41 -----------
  42
  43 The source code was hosted on Sourceforge for 16 years, but in
  44 2021 the development moved to github:
  45
  46 https://github.com/insilmaril/vym
  47
  48
  49 Installation
  50 ------------
  51
  52 * Binaries
  53
  54     Binaries for all major platforms can be found on:
  55
  56     https://sourceforge.net/projects/vym/
  57
  58     Packages there are: openSUSE rpm, Ubuntu deb, Apple dmg, Windows exe
  59
  60     More Linux like packages and developer versions are built in
  61     Open Build Service:
  62
  63     https://build.opensuse.org/package/show/home:insilmaril/vym
  64
  65
  66 * Compiling
  67
  68     Compiling vym from scratch is pretty easy, if you have the
  69     development packages of the Qt5 toolkit installed.
  70
  71     On the command line you can
  72
  73       cmake .
  74       make
  75       make install
  76
  77     or using Qt Creator:
  78
  79     In "File" do "Open file or project" and select the
  80     "CMakeLists.txt". This will setup the project.
  81
  82
  83 Questions and feedback
  84 ----------------------
  85
  86 Bugs and feature requests will be taken care of in
  87
  88   https://github.com/insilmaril/vym/issues
  89
  90 Please direct support questions to the mailinglist first:
  91
  92   vym-forum@lists.sourceforge.net
  93