From 96635e1ff46da225f11b5078da9a0b1e246a371d Mon Sep 17 00:00:00 2001 From: supahgreg Date: Mon, 6 Oct 2025 02:39:11 +0000 Subject: Home and Installation Guide content updates. --- Home.md | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) (limited to 'Home.md') diff --git a/Home.md b/Home.md index baad3c3..3454cd9 100644 --- a/Home.md +++ b/Home.md @@ -1,4 +1,4 @@ -Tiny Tiny RSS is a free and open source web-based news feed (RSS/Atom) reader and aggregator. +Tiny Tiny RSS (tt-rss) is a free, flexible, open source, web-based news feed (RSS/Atom/other) reader and aggregator. ## Screenshots @@ -26,31 +26,29 @@ Tiny Tiny RSS is a free and open source web-based news feed (RSS/Atom) reader an - and much more… - ~~[[Android Client]]~~ -## Development +## Installation + +You will need the following: +* A modern web browser. This generally means a recent version of Chrome/Chromium or Firefox. +* A system running Docker. + +See the [Docker installation guide](Installation-Notes) for detailed instructions. -See https://github.com/supahgreg/tt-rss . +> [!WARNING] +> If you choose to run tt-rss without using Docker support might be limited. + +> [!INFO] +> Tiny Tiny RSS uses a continuous development model based on the `main` branch, which is considered stable. +> It's strongly recommended that you remain current-- meaning using either the most recent Docker image(s) or commit on `main`. ## Get in touch * Go to https://github.com/supahgreg/tt-rss/discussions if you have questions or want to discuss something. * Go to https://github.com/supahgreg/tt-rss/issues if you want to report an issue, request an enhancement/feature, etc. -## Contribute - -Contributions (code, translations, reporting issues, etc.) are welcome. +## Development and Contributing +* Contributions (code, translations, reporting issues, etc.) are welcome. +* Development and issue tracking primarily happens in https://github.com/supahgreg/tt-rss . * (not quite ready for this post-`tt-rss.org`) ~~Help translate tt-rss into your own language using [Weblate](https://hosted.weblate.org/engage/tt-rss/)~~ -* [Code contribution guidelines](https://github.com/supahgreg/tt-rss/blob/main/CONTRIBUTING.md) - -## Installation - -You will need the following: - -* A modern web browser. This generally means a recent version of Chrome/Chromium or Firefox; -* A server (VDS or physical) running Docker; - -### [Docker installation guide](Installation-Notes) - -Tiny Tiny RSS uses a continuous development model based on the `main` branch, which is considered stable. If possible, you should always be running the latest `main` branch code. -There’s no warranty. If it breaks you get to keep both parts. -- cgit v1.2.3-54-g00ecf