From 48ffc595228fb957cdeb1f3ad139831c9d0dbae6 Mon Sep 17 00:00:00 2001 From: defnax Date: Mon, 21 Jul 2025 21:50:48 +0200 Subject: [PATCH] Created new readme --- README.asciidoc | 70 ------------------------------------------------- README.md | 46 ++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 70 deletions(-) delete mode 100644 README.asciidoc create mode 100644 README.md diff --git a/README.asciidoc b/README.asciidoc deleted file mode 100644 index 6e5c52ce9..000000000 --- a/README.asciidoc +++ /dev/null @@ -1,70 +0,0 @@ -// SPDX-FileCopyrightText: Retroshare Team -// SPDX-License-Identifier: CC-BY-SA-4.0 - -= RetroShare - -RetroShare is a decentralized, private, secure, cross-platform, communication -toolkit. -RetroShare provides file sharing, chat, messages, forums, channels and more. - -|=============================================================================== -| Developer Documentation | image:https://deepwiki.com/badge.svg[link="https://deepwiki.com/RetroShare/RetroShare",title="Ask DeepWiki"] -|=============================================================================== -.Build Status -|=============================================================================== -|GNU/Linux (via Gitlab CI) | image:https://gitlab.com/RetroShare/RetroShare/badges/master/pipeline.svg[link="https://gitlab.com/RetroShare/RetroShare/-/commits/master",title="pipeline status"] -|Windows (via AppVeyor) | image:https://ci.appveyor.com/api/projects/status/github/RetroShare/RetroShare?svg=true[link="https://ci.appveyor.com/project/RetroShare58622/retroshare"] -|macOS, (via Travis CI) | image:https://app.travis-ci.com/RetroShare/RetroShare.svg?branch=master[link="https://app.travis-ci.com/github/RetroShare/RetroShare"] -|libretroshare GNU/Linux, Android (via Gitlab CI) | image:https://gitlab.com/RetroShare/libretroshare/badges/master/pipeline.svg[link="https://gitlab.com/RetroShare/libretroshare/-/commits/master",title="pipeline status"] -|=============================================================================== - -== Get the source - -Clone this repository, enter the directory and then get the submodules with the -following command - -[source,bash] --------- -git submodule update --init --remote --force libbitdht/ libretroshare/ openpgpsdk/ --------- - - -== Compilation - -Short of comprehensive and updated documentation on how to build RetroShare -(for the many supported platforms it runs on), scripts and recipes are provided -in the aim of creating packages for the supported platforms (and more) -in the `build_scripts` directory of this repository. - -Those packaging receipts together with the continuous integration files -`.travis.yml` and `appveyor.yml` are a good source of knowledge on how to -compile RetroShare on different platforms. - - -== Using RetroShare on a headless computer with web UI - -WARNING: This section is outdated need to be adapted to the new web UI - -The web UI needs to be enabled as a parameter option to the retroshare-service: - -[source,bash] --------- -./retroshare-nogui --webinterface 9090 --docroot /usr/share/retroshare/webui/ --------- - -The web UI is only accessible on localhost:9090. It is advised to keep it that way so that your RS -cannot be controlled using an untrusted connection. - -To access your web UI from a distance, just open a SSH tunnel to it: - -[source,bash] --------- -distant_machine:~/ > ssh rs_host -L 9090:localhost:9090 -N --------- - -"rs_host" is the machine running `retroshare-nogui`. Then on the distant machine, access your web UI on - - - http://localhost:9090 - -(This can also be done from the RetroShare GUI.) diff --git a/README.md b/README.md new file mode 100644 index 000000000..04f1e8c95 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +## RetroShare + +RetroShare is a decentralized, private, secure, cross-platform, communication +toolkit. +RetroShare provides file sharing, chat, messages, forums, channels, boards and more. + +[![GitHub release](https://img.shields.io/github/release/retroshare/retroshare.svg?label=latest%20release)](https://github.com/retroshare/retroshare/releases/latest) +[![Downloads](https://img.shields.io/github/downloads/retroshare/retroshare/total)](https://github.com/retroshare/retroshare/releases/latest) +[![GNU/Linux (via Gitlab CI)](https://gitlab.com/RetroShare/RetroShare/badges/master/pipeline.svg)](https://gitlab.com/RetroShare/RetroShare/-/commits/master) +[![libretroshare GNU/Linux, Android (via Gitlab CI)](https://gitlab.com/RetroShare/libretroshare/badges/master/pipeline.svg)](https://gitlab.com/RetroShare/libretroshare/-/commits/master) +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/RetroShare/RetroShare) + +## Get the source + +Clone this repository, enter the directory and then get the submodules with the +following command + + git submodule update --init --remote --force libbitdht/ libretroshare/ openpgpsdk/ + + + +## Compilation + +Short of comprehensive and updated documentation on how to build RetroShare +(for the many supported platforms it runs on), scripts and recipes are provided +in the aim of creating packages for the supported platforms (and more) +in the [build_scripts](https://github.com/RetroShare/RetroShare/tree/master/build_scripts) directory of this repository. + +## Compilation on Windows +Follow this file : [WindowsMSys2_InstallGuide.md](https://github.com/RetroShare/RetroShare/blob/master/build_scripts/Windows-msys2/WindowsMSys2_InstallGuide.md) + +## Compilation on MacOSX + +Follow this file : [MacOS_X_InstallGuide](https://github.com/RetroShare/RetroShare/blob/master/build_scripts/OSX/MacOS_X_InstallGuide.md) + +## Releases + +Latest release [here](https://github.com/RetroShare/RetroShare/releases) + +Other Builds [RetroShare Downloads](https://retroshare.cc/downloads.html) + + +## Documentation + +- [RetroShare Docs](https://retrosharedocs.readthedocs.io/en/latest/) +