From 291ed9d7e315fda096e28ff2906b316a825b37bb Mon Sep 17 00:00:00 2001 From: Michael Keller Date: Sat, 1 Jun 2024 09:42:51 +1200 Subject: [PATCH] Documentation: Update Information on Available Versions in README.md. Update the information on the available versions of Subsurface in README. Also update the documentation to reflect the renaming of `INSTALL` to `INSTALL.md`. Signed-off-by: Michael Keller --- .../50-pot/subsurface-user-manual.pot | 2 +- .../fr/po/subsurface-user-manual.fr.po | 4 ++-- Documentation/user-manual.html.git | 2 +- Documentation/user-manual.txt | 2 +- Documentation/user-manual_es.html.git | 2 +- Documentation/user-manual_es.txt | 2 +- Documentation/user-manual_fr.html.git | 2 +- Documentation/user-manual_fr.txt | 2 +- Documentation/user-manual_nl.html.git | 2 +- Documentation/user-manual_nl.txt | 2 +- README.md | 23 ++++--------------- 11 files changed, 16 insertions(+), 29 deletions(-) diff --git a/Documentation/50-pot/subsurface-user-manual.pot b/Documentation/50-pot/subsurface-user-manual.pot index 08808fc74..037178811 100644 --- a/Documentation/50-pot/subsurface-user-manual.pot +++ b/Documentation/50-pot/subsurface-user-manual.pot @@ -135,7 +135,7 @@ msgid "" "mailto:subsurface@subsurface-divelog.org[our mailing list] and report bugs " "at https://github.com/Subsurface/subsurface/issues[our bugtracker]. " "For instructions on how to build the software and (if needed) its " -"dependencies please consult the INSTALL file included with the source code." +"dependencies please consult the INSTALL.md file included with the source code." msgstr "" #. type: Plain text diff --git a/Documentation/fr/po/subsurface-user-manual.fr.po b/Documentation/fr/po/subsurface-user-manual.fr.po index f15741e4b..88463835c 100644 --- a/Documentation/fr/po/subsurface-user-manual.fr.po +++ b/Documentation/fr/po/subsurface-user-manual.fr.po @@ -175,7 +175,7 @@ msgid "" "an email to mailto:subsurface@subsurface-divelog.org[our mailing list] and " "report bugs at https://github.com/Subsurface-divelog/subsurface/issues[our " "bugtracker]. For instructions on how to build the software and (if needed) " -"its dependencies please consult the INSTALL file included with the source " +"its dependencies please consult the INSTALL.md file included with the source " "code." msgstr "" "Ce manuel explique comment utiliser le programme _Subsurface_. Pour " @@ -184,7 +184,7 @@ msgstr "" "pouvez envoyer un e-mail sur mailto:subsurface@subsurface-divelog.org[notre " "liste de diffusion] et rapportez les bogues sur http://trac.hohndel." "org[notre bugtracker]. Pour des instructions de compilation du logiciel et " -"(si besoin) de ses dépendances, merci de consulter le fichier INSTALL inclus " +"(si besoin) de ses dépendances, merci de consulter le fichier INSTALL.md inclus " "dans les sources logicielles." #. type: Plain text diff --git a/Documentation/user-manual.html.git b/Documentation/user-manual.html.git index e4eafb30a..ca2dcc395 100644 --- a/Documentation/user-manual.html.git +++ b/Documentation/user-manual.html.git @@ -460,7 +460,7 @@ the software, consult the Downloads page on the Please discuss issues with this program by sending an email to our mailing list and report bugs at our bugtracker. For instructions on how to build the -software and (if needed) its dependencies please consult the INSTALL file +software and (if needed) its dependencies please consult the INSTALL.md file included with the source code.

Audience: Recreational Scuba Divers, Free Divers, Tec Divers, Professional Divers

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 73731e70f..ef82d8000 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -34,7 +34,7 @@ https://subsurface-divelog.org/[_Subsurface_ web site]. Please discuss issues with this program by sending an email to mailto:subsurface@subsurface-divelog.org[our mailing list] and report bugs at https://github.com/Subsurface/subsurface/issues[our bugtracker]. For instructions on how to build the -software and (if needed) its dependencies please consult the INSTALL file +software and (if needed) its dependencies please consult the INSTALL.md file included with the source code. *Audience*: Recreational Scuba Divers, Free Divers, Tec Divers, Professional diff --git a/Documentation/user-manual_es.html.git b/Documentation/user-manual_es.html.git index 0d232bbef..c56c4958d 100644 --- a/Documentation/user-manual_es.html.git +++ b/Documentation/user-manual_es.html.git @@ -517,7 +517,7 @@ web. Por favor, comenta los problemas que tengas con este programa enviando mail a nuestra lista de correo e informa de fallos en nuestro bugtracker. Para instrucciones acerca de como compilar el software y (en caso necesario) -sus dependencias, por favor, consulta el archivo INSTALL incluido con el código +sus dependencias, por favor, consulta el archivo INSTALL.md incluido con el código fuente.

Audiencia: Buceadores recreativos, Buceadores en apnea, Buceadores técnicos, Buceadores profesionales.

diff --git a/Documentation/user-manual_es.txt b/Documentation/user-manual_es.txt index cb42c39ba..1ad921420 100644 --- a/Documentation/user-manual_es.txt +++ b/Documentation/user-manual_es.txt @@ -61,7 +61,7 @@ web]. Por favor, comenta los problemas que tengas con este programa enviando un mail a mailto:subsurface@subsurface-divelog.org[nuestra lista de correo] e informa de fallos en https://github.com/Subsurface/subsurface/issues[nuestro bugtracker]. Para instrucciones acerca de como compilar el software y (en caso necesario) -sus dependencias, por favor, consulta el archivo INSTALL incluido con el código +sus dependencias, por favor, consulta el archivo INSTALL.md incluido con el código fuente. *Audiencia*: Buceadores recreativos, Buceadores en apnea, Buceadores técnicos, diff --git a/Documentation/user-manual_fr.html.git b/Documentation/user-manual_fr.html.git index 1f6bc655c..a4e9db1ec 100644 --- a/Documentation/user-manual_fr.html.git +++ b/Documentation/user-manual_fr.html.git @@ -526,7 +526,7 @@ problème, vous pouvez envoyer un e-mail sur notre liste de diffusion et rapportez les bogues sur notre bugtracker. Pour des instructions de compilation du logiciel et (si besoin) de ses -dépendances, merci de consulter le fichier INSTALL inclus dans les sources +dépendances, merci de consulter le fichier INSTALL.md inclus dans les sources logicielles.

Public : Plongeurs loisirs, apnéistes, plongeurs Tek et plongeurs professionnels

diff --git a/Documentation/user-manual_fr.txt b/Documentation/user-manual_fr.txt index ec22c0a8c..2ffc986eb 100644 --- a/Documentation/user-manual_fr.txt +++ b/Documentation/user-manual_fr.txt @@ -61,7 +61,7 @@ problème, vous pouvez envoyer un e-mail sur mailto:subsurface@subsurface-divelog.org[notre liste de diffusion] et rapportez les bogues sur http://trac.hohndel.org[notre bugtracker]. Pour des instructions de compilation du logiciel et (si besoin) de ses -dépendances, merci de consulter le fichier INSTALL inclus dans les sources +dépendances, merci de consulter le fichier INSTALL.md inclus dans les sources logicielles. *Public* : Plongeurs loisirs, apnéistes, plongeurs Tek et plongeurs diff --git a/Documentation/user-manual_nl.html.git b/Documentation/user-manual_nl.html.git index d5bc52daa..0af1becc4 100644 --- a/Documentation/user-manual_nl.html.git +++ b/Documentation/user-manual_nl.html.git @@ -516,7 +516,7 @@ het programma kunnen bij de ontwikkelaars gemeld worden via email op onze mailinglijst. Fouten kunnen ook gemeld worden op onze bugtracker. Instructies hoe Subsurface zelf te compileren vanuit de broncode staan ook op -onze website en in het INSTALL bestand in de broncode.

+onze website en in het INSTALL.md bestand in de broncode.

Doelgroep: Recreatieve duikers, Tec duikers, Apneu duikers, Professionele duikers.

diff --git a/Documentation/user-manual_nl.txt b/Documentation/user-manual_nl.txt index 7c741a3c6..8dd052d36 100644 --- a/Documentation/user-manual_nl.txt +++ b/Documentation/user-manual_nl.txt @@ -59,7 +59,7 @@ het programma kunnen bij de ontwikkelaars gemeld worden via email op mailto:subsurface@subsurface-divelog.org[onze mailinglijst]. Fouten kunnen ook gemeld worden op https://github.com/Subsurface/subsurface/issues[onze bugtracker]. Instructies hoe _Subsurface_ zelf te compileren vanuit de broncode staan ook op -onze website en in het INSTALL bestand in de broncode. +onze website en in het INSTALL.md bestand in de broncode. *Doelgroep*: Recreatieve duikers, Tec duikers, Apneu duikers, Professionele duikers. diff --git a/README.md b/README.md index 42a75b0a9..b42634120 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,9 @@ Report bugs and issues at https://github.com/Subsurface/subsurface/issues License: GPLv2 -We frequently make new test versions of Subsurface available at -http://subsurface-divelog.org/downloads/test/ and there you can always get -the latest builds for Mac, Windows, Linux AppImage and Android (with some -caveats about installability). Additionally, those same versions are +We are releasing 'nightly' builds of Subsurface that are built from the latest version of the code. Versions of this build for Windows, macOS, Android (requiring sideloading), and a Linux AppImage can be downloaded from the [Latest Dev Release](https://www.subsurface-divelog.org/latest-release/) page on [our website](https://www.subsurface-divelog.org/). Alternatively, they can be downloaded [directly from GitHub](https://github.com/subsurface/nightly-builds/releases). Additionally, those same versions are posted to the Subsurface-daily repos on Ubuntu Launchpad, Fedora COPR, and -OpenSUSE OBS. - -These tend to contain the latest bug fixes and features, but also -occasionally the latest bugs and issues. Please understand when using them -that these are primarily intended for testing. +OpenSUSE OBS, and released to [Snapcraft](https://snapcraft.io/subsurface) into the 'edge' channel of subsurface. You can get the sources to the latest development version from the git repository: @@ -42,17 +35,11 @@ git clone https://github.com/Subsurface/subsurface.git You can also fork the repository and browse the sources at the same site, simply using https://github.com/Subsurface/subsurface -If you want the latest release (instead of the bleeding edge -development version) you can either get this via git or the release tar -ball. After cloning run the following command: +Additionally, artifacts for Windows, macOS, Android, Linux AppImage, and iOS (simulator build) are generated for all open pull requests and linked in pull request comments. Use these if you want to test the changes in a specific pull request and provide feedback before it has been merged. -``` -git checkout v5.0.10 (or whatever the last release is) -``` +If you want a more stable version that is a little bit more tested you can get this from the [Curent Release](https://www.subsurface-divelog.org/current-release/) page on [our website](https://www.subsurface-divelog.org/). -or download a tarball from http://subsurface-divelog.org/downloads/Subsurface-5.0.10.tgz - -Detailed build instructions can be found in the INSTALL file. +Detailed build instructions can be found in the [INSTALL.md](/INSTALL.md) file. ## System Requirements