From 37590599ad4c530c8212a7b94d0f98c16b41a811 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20=E2=80=9CNiols=E2=80=9D=20Jeannerod?= Date: Wed, 27 Nov 2024 12:21:33 +0100 Subject: [PATCH] Basic README file --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b019c36..c87beb5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ -# Fediversity +# The Fediversity project +This repository contains all the code and code-related files having to do with +[the Fediversity project](https://fediversity.eu/), with the notable exception +of [NixOps4 that is hosted on GitHub](https://github.com/nixops4/nixops4). + +## Content of this repository + +Most of the directories in this repository have their own README going into more +details as to what they are for. As an overview: + +- [`deployment/`](./deployment) contains bits and pieces having to do with + auto-deployment of test VMs on a private Proxmox. + +- [`infra/`](./infra) contains the configurations for the various VMs that are + in production for the project, for instance the Git instances or the Wiki. + +- [`matrix/`](./matrix) contains everything having to do with setting up a + fully-featured Matrix server. + +- [`server/`](./server) contains the configuration of the VM hosting the + website. This should be integrated into `infra/` shortly in the future, as + tracked in https://git.fediversity.eu/Fediversity/Fediversity/issues/31. + +- [`services/`](./services) contains our effort to make Fediverse applications + work seemlessly together in our specific setting. + +- [`website/`](./website) contains the framework and the content of [the + Fediversity website](https://fediversity.eu/)