X-Git-Url: https://git.sven.stormbind.net/?a=blobdiff_plain;f=README.md;h=acaf9e663f7f609d98191013c7e5f240c0fdd745;hb=HEAD;hp=6334cde86d33839e9e926f47ef817e718411889e;hpb=7dfa3fe589d1722d49681f42cdb0bf1e6efb5223;p=sven%2Fvym.git diff --git a/README.md b/README.md index 6334cde..acaf9e6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -###VYM - View Your Mind (c) 2004-2017 by Uwe Drechsel### +VYM - View Your Mind (c) 2004-2024 by Uwe Drechsel +================================================== Documentation ------------- @@ -6,19 +7,24 @@ Documentation * PDF The complete documentation of vym is available as PDF document in - english and spanish. (The spanish version is not really up to date, - translators are welcome). It can be accessed directly from vym via - the help section It also can be downloaded from the vym site at - Sourceforge: + 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://sourceforge.net/projects/vym/ + 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 - feature of vym and how to use them: + features of vym and how to use them: - http://www.youtube.com/user/ViewYourMind + http://www.youtube.com/user/ViewYourMind Download @@ -27,13 +33,23 @@ Download The official downloads for all platforms are available at the project site: - https://sourceforge.net/projects/vym/ +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 + -The latest binaries for Linux (currently mainly openSUSE) are found in the -Open Build Service project of Uwe Drechsel (aka insilmaril): +Source code +----------- - http://download.opensuse.org/repositories/home%3A//insilmaril/ +The source code was hosted on Sourceforge for 16 years, but in +2021 the development moved to github: +https://github.com/insilmaril/vym Installation @@ -41,43 +57,43 @@ Installation * Binaries - Installation depends on the platform you use, please check the - homepage for details: + Binaries for all major platforms can be found on: - http://www.insilmaril.de/vym + https://sourceforge.net/projects/vym/ -* Compiling + Packages there are: openSUSE rpm, Ubuntu deb, Apple dmg, Windows exe - Compiling vym from scratch is pretty easy, if you have the - development packages of the Qt5 toolkit installed. (Check also the - homepage above for details): + More Linux like packages and developer versions are built in + Open Build Service: + + https://build.opensuse.org/package/show/home:insilmaril/vym - qmake - make - make install -* Testing (without installing!) +* Compiling + + Compiling vym from scratch is pretty easy, if you have the + development packages of the Qt5 toolkit installed. - You can also run vym virtually in your webbrowser: vym is available - as appliance in SUSE Studio. SUSE Studio is a very easy way to - create appliances, which are customized Linux operating systems. + On the command line you can - All you need is to quickly create a free account and search for - "vym" by user "insilmaril" in the gallery: + cmake . + make + make install - http://susestudio.com + or using Qt Creator: - The appliance can be downloaded as installable iso image, or run in - the testdrive - in your webbrowser! That's a bit slow, but gives you - an idea without having to install anything at all on your system. + In "File" do "Open file or project" and select the + "CMakeLists.txt". This will setup the project. Questions and feedback ---------------------- -Please direct questions to the mailinglist first: +Bugs and feature requests will be taken care of in - vym-forum@lists.sourceforge.net + https://github.com/insilmaril/vym/issues +Please direct support questions to the mailinglist first: + vym-forum@lists.sourceforge.net