radicle-heartwood-lfs/.github
Maciek "mab122" Bator 2306aabc4a docs: add fork banner to .github/README.md (GitHub profile-README convention)
Matches the banner already on the root README.md -- this file is
otherwise upstream heartwood's own GitHub-specific profile readme,
unrelated to and predating the LFS-over-IPFS work, so someone landing
on it directly (or via GitHub's own rendering convention) had no
indication this repo is a fork with different setup instructions.
2026-07-17 09:33:39 +02:00
..
workflows ci: Update GitHub action `actions/cache` 2026-04-22 15:31:31 +01:00
README.md docs: add fork banner to .github/README.md (GitHub profile-README convention) 2026-07-17 09:33:39 +02:00

README.md

❤️🪵

Fork: Git LFS support, backed by IPFS

This is a fork of upstream radicle-dev/heartwood adding Git LFS (large file) support, with large file content stored on each contributor's own local IPFS node rather than a central server. Everything below is upstream's own text, unchanged, and describes upstream heartwood in general, not this fork specifically.

This repository is developed on a self-hosted Forgejo instance, not GitHub — see the main README.md for the fork's own quickstart, and LFS-IPFS.md for the full design, encryption details, and troubleshooting.

Radicle Heartwood Protocol & Stack

Heartwood is the third iteration of the Radicle Protocol, a powerful peer-to-peer code collaboration and publishing stack. The repository contains a full implementation of Heartwood, complete with a user-friendly command-line interface (rad) and network daemon (radicle-node).

Radicle is a secure, decentralized and powerful alternative to centralized code forges such as GitHub and GitLab that preserves user sovereignty and freedom.

See the Protocol Guide for an in-depth description of how Radicle works.

For more information about installing and running Radicle, how to contribute, and licensing, please refer to the main README.md of the repository.

Radicle on GitHub

Please note that GitHub is not the forge that Radicle is being developed with. Radicle is developed using Radicle. Therefore, issues cannot be created on GitHub, but only via Radicle directly. However, pull requests are still accepted.

To view existing issues and patches with your web browser, navigate to radicle.network.

To contribute issues and patches, please consider installing Radicle and follow our guides.

Feedback

If you have feedback, feel free to create issues using rad issue, join our Zulip, or email feedback@radicle.dev. Emails sent to this address are automatically posted to our public #feedback channel on Zulip, revealing the From header (which usually contains your name and email address). This allows us to discuss your feedback on Zulip, and, if necessary, respond to you via email.