README.md

   1 VYM - View Your Mind (c) 2004-2024 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 * Release notes and changelog
  17
  18     Can either be downloaded directly in vym via
  19     "Help - Download and show release notes" or can be accessed in
  20     https://github.com/insilmaril/vym/blob/release/release-notes-2.9.md
  21
  22 * Screencasts
  23
  24     There are several screencasts available on YouTube, which show some
  25     features of vym and how to use them:
  26
  27     http://www.youtube.com/user/ViewYourMind
  28
  29
  30 Download
  31 --------
  32
  33 The official downloads for all platforms are available at the project
  34 site:
  35
  36 https://sourceforge.net/projects/vym/
  37
  38 The latest development drops can be found in the Files/Development folder there.
  39
  40 The latest binaries for Linux, Debian and Ubuntu are built and available in the authors
  41 Open Build Service project:
  42
  43 https://software.opensuse.org/download.html?project=home%3Ainsilmaril&package=vym
  44
  45
  46 Source code
  47 -----------
  48
  49 The source code was hosted on Sourceforge for 16 years, but in
  50 2021 the development moved to github:
  51
  52 https://github.com/insilmaril/vym
  53
  54
  55 Installation
  56 ------------
  57
  58 * Binaries
  59
  60     Binaries for all major platforms can be found on:
  61
  62     https://sourceforge.net/projects/vym/
  63
  64     Packages there are: openSUSE rpm, Ubuntu deb, Apple dmg, Windows exe
  65
  66     More Linux like packages and developer versions are built in
  67     Open Build Service:
  68
  69     https://build.opensuse.org/package/show/home:insilmaril/vym
  70
  71
  72 * Compiling
  73
  74     Compiling vym from scratch is pretty easy, if you have the
  75     development packages of the Qt5 toolkit installed.
  76
  77     On the command line you can
  78
  79       cmake .
  80       make
  81       make install
  82
  83     or using Qt Creator:
  84
  85     In "File" do "Open file or project" and select the
  86     "CMakeLists.txt". This will setup the project.
  87
  88
  89 Questions and feedback
  90 ----------------------
  91
  92 Bugs and feature requests will be taken care of in
  93
  94   https://github.com/insilmaril/vym/issues
  95
  96 Please direct support questions to the mailinglist first:
  97
  98   vym-forum@lists.sourceforge.net
  99