From 973714a4ee84dc6ddbd970a95d02482c81e403d0 Mon Sep 17 00:00:00 2001 From: madomado Date: Sat, 10 Aug 2024 11:35:13 +0800 Subject: [PATCH] docs: update readme and contributing (#1822) * docs: update readme and contributing * more links * Update CONTRIBUTING.md Signed-off-by: madomado --------- Signed-off-by: madomado --- CONTRIBUTING.md | 10 ++++------ README.md | 21 ++++++++++++++++++--- 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a75ea47b81..c856278454 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,7 @@ # Contributing -First of all, thanks for being interested in contributing to Terra! If you have any questions about contributing, please contact us on [Discord](https://discord.gg/5fdPuxTg5Q). +First of all, thanks for being interested in contributing to Terra! If you have any questions about contributing, please [join our chats](https://wiki.ultramarine-linux.org/en/community/community/). -## Documentations - -* [Contribution Guide](https://developer.fyralabs.com/terra/contributing) -* [FAQ](https://developer.fyralabs.com/terra/faq) -* [Policy](https://developer.fyralabs.com/terra/policy) +- [Contribution Guide](https://developer.fyralabs.com/terra/contributing) +- [FAQ](https://developer.fyralabs.com/terra/faq) +- [Policy](https://developer.fyralabs.com/terra/policy) diff --git a/README.md b/README.md index 986554e572..8740779b1d 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,31 @@ Terra is a rolling-release Fedora repository for all the software you need. With Terra, you can install the latest packages knowing that quality and security are assured. +See the introduction at [our website](https://terra.fyralabs.com). + This monorepo contains the package manifests for all packages in Terra. ## Installation + ```bash sudo dnf install --repofrompath 'terra,https://repos.fyralabs.com/terra$releasever' --setopt='terra.gpgkey=https://repos.fyralabs.com/terra$releasever/key.asc' terra-release ``` -You should also install the `terra-release` package so that when our infrastructure has any migrations, you can be assured that your Terra installation will still work as-is. + +If you are using immutable/atomic editions of Fedora, run the following commands instead: + +```bash +curl -fsSL https://github.com/terrapkg/subatomic-repos/raw/main/terra.repo | pkexec tee /etc/yum.repos.d/terra.repo +sudo rpm-ostree install terra-release +``` ## Documentation -Our documentation can be found on our [Devdocs](https://developer.fyralabs.com/terra/). Alternatively, the GitHub Wiki contains older versions of the documentations. + +Our documentation can be found on our [Devdocs](https://developer.fyralabs.com/terra/). ## Questions? -Feel free to reach out on [Discord](https://discord.gg/5fdPuxTg5Q). We're always happy to help! + +Feel free to reach out by [joining our community](https://wiki.ultramarine-linux.org/en/community/community/). We're always happy to help! + +- [Contribution Guide](https://developer.fyralabs.com/terra/contributing) +- [FAQ](https://developer.fyralabs.com/terra/faq) +- [Policy](https://developer.fyralabs.com/terra/policy)