VYM - View Your Mind (c) 2004-2024 by Uwe Drechsel
==================================================

Documentation
-------------

* PDF

    The complete documentation of vym is available as PDF document in
    English, French and Spanish. (Only the English version is really up
    to date, translators are welcome). PDFs can be accessed directly from
    vym via the help section. They also can be downloaded from github at

    https://github.com/insilmaril/vym/tree/develop/doc

* Release notes and changelog

    Can either be downloaded directly in vym via
    "Help - Download and show release notes" or can be accessed in
    https://github.com/insilmaril/vym/blob/release/release-notes-2.9.md

* Screencasts

    There are several screencasts available on YouTube, which show some
    features of vym and how to use them:

    http://www.youtube.com/user/ViewYourMind


Download
--------

The official downloads for all platforms are available at the project
site:

https://sourceforge.net/projects/vym/

The latest development drops can be found in the Files/Development folder there.

The latest binaries for Linux, Debian and Ubuntu are built and available in the authors
Open Build Service project:

https://software.opensuse.org/download.html?project=home%3Ainsilmaril&package=vym


Source code
-----------

The source code was hosted on Sourceforge for 16 years, but in
2021 the development moved to github:

https://github.com/insilmaril/vym


Installation
------------

* Binaries

    Binaries for all major platforms can be found on:

    https://sourceforge.net/projects/vym/

    Packages there are: openSUSE rpm, Ubuntu deb, Apple dmg, Windows exe

    More Linux like packages and developer versions are built in
    Open Build Service:

    https://build.opensuse.org/package/show/home:insilmaril/vym


* Compiling

    Compiling vym from scratch is pretty easy, if you have the
    development packages of the Qt5 toolkit installed.

    On the command line you can

      cmake .
      make
      make install

    or using Qt Creator:

    In "File" do "Open file or project" and select the
    "CMakeLists.txt". This will setup the project.


Questions and feedback
----------------------

Bugs and feature requests will be taken care of in

  https://github.com/insilmaril/vym/issues

Please direct support questions to the mailinglist first:

  vym-forum@lists.sourceforge.net

