Go to file
jolavillette 1b67abdf96 ci(macos): give the restbed patch step a GNU sed
The restbed FetchContent block patches the fetched CMakeLists with

    sed -i -e "s|/wd4251||g" ...

which is GNU syntax. BSD sed, the one macOS ships, reads what follows -i as a
backup suffix, so it takes "-e" as a filename and stops with

    sed: -e: No such file or directory

The super-project never runs into this: it carries restbed as a submodule, so
the add_subdirectory branch is taken and FetchContent -- with its patch step --
never runs. The standalone build has no submodule and always goes through
FetchContent, which is why this surfaces here and nowhere else.

Fixed by putting Homebrew's GNU sed first in PATH for the configure step, rather
than by touching CMakeLists.txt.
2026-08-15 11:41:41 +02:00
.github/workflows ci(macos): give the restbed patch step a GNU sed 2026-08-15 11:41:41 +02:00
.reuse Fix G10h4ck copyright attribution treewide 2026-06-14 12:13:43 +02:00
gradle/wrapper More work to ship libretroshare as standalone lib 2022-01-10 15:40:22 +01:00
LICENSES Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
misc/Android Fix G10h4ck copyright attribution treewide 2026-06-14 12:13:43 +02:00
src Merge pull request #365 from defnax/api-for-getBoardPostSummaries 2026-08-13 21:01:17 +02:00
tests Fix G10h4ck copyright attribution treewide 2026-06-14 12:13:43 +02:00
.gitattributes More work to ship libretroshare as standalone lib 2022-01-10 15:40:22 +01:00
.gitignore libretroshare: implement RsGxsWikiEvent and clean dummy code 2026-01-03 15:31:49 +00:00
.gitlab-ci.yml Fix Android build for ndk r29 on ubuntu 26.04 2026-06-14 11:44:03 +02:00
build.gradle Fix Android build for ndk r29 on ubuntu 26.04 2026-06-14 11:44:03 +02:00
CMakeLists.txt build(cmake): add options to build the GXS Wiki and The Wire services 2026-08-03 12:20:53 +02:00
COPYING Add COPYING 2020-04-01 16:35:22 +02:00
gradlew More work to ship libretroshare as standalone lib 2022-01-10 15:40:22 +01:00
gradlew.bat More work to ship libretroshare as standalone lib 2022-01-10 15:40:22 +01:00
README.asciidoc Fix README typo 2026-06-14 12:54:05 +02:00
settings.gradle More work to ship libretroshare as standalone lib 2022-01-10 15:40:22 +01:00

// SPDX-FileCopyrightText: 2022 Retroshare Team <contact@retroshare.cc>
// SPDX-FileCopyrightText: 2022-2026 Gioacchino Mazzurco <gio@retroshare.cc>
// SPDX-License-Identifier: CC-BY-SA-4.0

== RetroShare library

RetroShare is a decentralized, private, secure, cross-platform, communication
software.

RetroShare functionalities (file sharing, chat, messages, forums, channels...)
are implemented under the hood by libretroshare which offers a documented C++ and
JSON API.

While RetroShare is an application on its own, libretroshare is meant to be
used as part of other programs, some of them are
https://retroshare.cc[RetroShare-gui],
https://retroshare.cc[RetroShare-service],
https://gitlab.com/elRepo.io/elRepo.io-android[elRepo.io]
(let us know if there are more).


=== Continuous integration

image:https://gitlab.com/RetroShare/libretroshare/badges/master/pipeline.svg[link="https://gitlab.com/RetroShare/libretroshare/-/commits/master",title="pipeline status"]

=== Developer Documentation

All public API methods are documented with Doxygen comments, so the most updated
way to read documentation is reading those comments in `src/retroshare/`.

To use libretroshare as part of your Android application we suggest to add our
maven repository, and then specify the variant and version that fits your needs
as dependency. RetroShare is then exposed as an Android Service as you can see
at https://gitlab.com/RetroShare/libretroshare/-/blob/master/src/rs_android/org/retroshare/service/RetroShareServiceAndroid.java?ref_type=heads[RetroShareServiceAndroid.java] start it and then interact with it
via RetroShare JSON API.

.Example of adding libretroshare as dependency in Gradle
--------------------------------------------------------------------------------
repositories {
	maven {
		url "https://gitlab.com/api/v4/projects/32730908/packages/maven"
	}
}

dependencies {
	// Look at https://gitlab.com/RetroShare/libretroshare/-/packages for
	// available options.
	//                 Minimum Android platform supported goes here ⬇
	//                                            Build variant goes here ⬇
	//                                                          Version goes here ⬇
	implementation "org.retroshare.service:libretroshare-MinApiLevel21-release:72f8b7e8"
}
--------------------------------------------------------------------------------


{empty} +

image:https://deepwiki.com/badge.svg[link="https://deepwiki.com/RetroShare/libretroshare",title="Ask DeepWiki"]