diff options
| author | 2022-11-20 14:47:27 +0100 | |
|---|---|---|
| committer | 2022-11-20 14:47:27 +0100 | |
| commit | be57be5ab289a2102a458601a1eadada6425e584 (patch) | |
| tree | 2b1bb2288195b95d38c2730c2f6120d78d1958bc | |
| parent | 278e07f7bdfc1c81129a261d59311bc82461366c (diff) | |
Add Codespaces badge (#4867)
Follow-up of https://github.com/FreshRSS/FreshRSS/pull/4860 , https://github.com/FreshRSS/FreshRSS/pull/4859
Discussion https://github.com/FreshRSS/FreshRSS/discussions/4861
With slight rework of some elements of the readme around
| -rw-r--r-- | README.fr.md | 46 | ||||
| -rw-r--r-- | README.md | 28 |
2 files changed, 35 insertions, 39 deletions
diff --git a/README.fr.md b/README.fr.md index cf98311ac..ce36a6b34 100644 --- a/README.fr.md +++ b/README.fr.md @@ -5,7 +5,7 @@ # FreshRSS -FreshRSS est un agrégateur de flux RSS à auto-héberger à l’image de [Leed](https://github.com/LeedRSS/Leed) ou de [Kriss Feed](https://tontof.net/kriss/feed/). +FreshRSS est un agrégateur de flux RSS à auto-héberger. Il se veut léger et facile à prendre en main tout en étant un outil puissant et paramétrable. @@ -19,21 +19,29 @@ FreshRSS supporte nativement le moissonnage du Web (Web Scraping) basique, basé Enfin, il permet l’ajout d’[extensions](#extensions) pour encore plus de personnalisation. -Les demandes de fonctionnalités, rapports de bugs, et autres contributions sont les bienvenues. Privilégiez pour cela des [demandes sur GitHub](https://github.com/FreshRSS/FreshRSS/issues). -Nous sommes une communauté amicale. - * Site officiel : <https://freshrss.org> * Démo : <http://demo.freshrss.org/> * Licence : [GNU AGPL 3](https://www.gnu.org/licenses/agpl-3.0.fr.html)  -# Avertissements +## Contributions -FreshRSS n’est fourni avec aucune garantie. +Les demandes de fonctionnalités, rapports de bugs, et autres contributions sont les bienvenues. Privilégiez pour cela des [demandes sur GitHub](https://github.com/FreshRSS/FreshRSS/issues). +Nous sommes une communauté amicale. + +Pour faciliter les contributions, l’option suivante est disponible : + +[](https://github.com/codespaces/new?hide_repo_select=true&ref=edge&repo=6322699) + +## Capture d’écran  +## Avertissements + +FreshRSS n’est fourni avec aucune garantie. + # [Documentation](https://freshrss.github.io/FreshRSS/fr/) * La [documentation utilisateurs](https://freshrss.github.io/FreshRSS/fr/users/02_First_steps.html) pour découvrir les fonctionnalités de FreshRSS. @@ -41,7 +49,7 @@ FreshRSS n’est fourni avec aucune garantie. * La [documentation développeurs](https://freshrss.github.io/FreshRSS/fr/developers/01_First_steps.html) pour savoir comment contribuer et mieux comprendre le code source de FreshRSS. * Le [guide de contribution](https://freshrss.github.io/FreshRSS/fr/contributing.html) pour nous aider à développer FreshRSS. -# Prérequis +## Prérequis * Un navigateur Web récent tel que Firefox / IceCat, Edge, Chromium / Chrome, Opera, Safari. * Fonctionne aussi sur mobile (sauf certaines fonctionnalités) @@ -53,16 +61,12 @@ FreshRSS n’est fourni avec aucune garantie. * Recommandés : [GMP](https://www.php.net/gmp) (pour accès API sur plateformes < 64 bits), [IDN](https://www.php.net/intl.idn) (pour les noms de domaines internationalisés), [mbstring](https://www.php.net/mbstring) (pour le texte Unicode), [iconv](https://www.php.net/iconv) (pour conversion d’encodages), [ZIP](https://www.php.net/zip) (pour import/export), [zlib](https://www.php.net/zlib) (pour les flux compressés) * MySQL 5.5.3+ ou équivalent MariaDB, ou SQLite 3.7.4+, ou PostgreSQL 9.5+ - -# Téléchargement +# [Installation](https://freshrss.github.io/FreshRSS/fr/users/01_Installation.html) Si vous préférez que votre FreshRSS soit stable, vous devriez télécharger la dernière version. De nouvelles versions sont publiées tous les 2 ou 3 mois. Voir la [liste des versions](https://github.com/FreshRSS/FreshRSS/releases). Si vous voulez une publication continue (rolling release) avec les dernières nouveautés, ou bien aider à tester ou développer la future version stable, vous pouvez utiliser [la branche edge](https://github.com/FreshRSS/FreshRSS/tree/edge/). - -# [Installation](https://freshrss.github.io/FreshRSS/fr/users/01_Installation.html) - ## Installation automatisée * [<img src="https://www.docker.com/wp-content/uploads/2022/03/horizontal-logo-monochromatic-white.png" width="200" alt="Docker" />](./Docker/) @@ -83,7 +87,7 @@ Si vous voulez une publication continue (rolling release) avec les dernières no Plus d’informations sur l’installation et la configuration serveur peuvent être trouvées dans [notre documentation](https://freshrss.github.io/FreshRSS/fr/users/01_Installation.html). -### Exemple d’installation complète sur Linux Debian/Ubuntu +## Exemple d’installation complète sur Linux Debian/Ubuntu ```sh # Si vous utilisez le serveur Web Apache (sinon il faut un autre serveur Web) @@ -155,7 +159,7 @@ Créer `/etc/cron.d/FreshRSS` avec : 7,37 * * * * www-data php -f /usr/share/FreshRSS/app/actualize_script.php > /tmp/FreshRSS.log 2>&1 ``` -## Conseils +# Conseils * Pour une meilleure sécurité, faites en sorte que seul le répertoire `./p/` soit accessible depuis le Web, par exemple en faisant pointer un sous-domaine sur le répertoire `./p/`. * En particulier, les données personnelles se trouvent dans le répertoire `./data/`. @@ -175,19 +179,7 @@ Créer `/etc/cron.d/FreshRSS` avec : * Il faut conserver vos fichiers `./data/config.php` ainsi que `./data/users/*/config.php` * Vous pouvez exporter votre liste de flux au format OPML soit depuis l’interface Web, soit [en ligne de commande](cli/README.md) -Pour sauvegarder les articles eux-mêmes : - -## Dans le cas où vous utilisez MySQL - -Vous pouvez utiliser [phpMyAdmin](https://www.phpmyadmin.net) ou les outils de MySQL : - -```sh -mysqldump --skip-comments --disable-keys --user=<db_user> --password --host <db_host> --result-file=freshrss.dump.sql --databases <freshrss_db> -``` - -## Pour toutes les bases supportées - -Vous pouvez utiliser la [ligne de commande](cli/README.md) pour exporter votre base de données vers une base de données au format SQLite : +Pour sauvegarder les articles eux-mêmes, vous pouvez utiliser la [ligne de commande](cli/README.md) pour exporter votre base de données vers une base de données au format SQLite : ```sh ./cli/export-sqlite-for-user.php --user <username> --filename </path/to/db.sqlite> @@ -5,7 +5,7 @@ # FreshRSS -FreshRSS is a self-hosted RSS feed aggregator like [Leed](https://github.com/LeedRSS/Leed) or [Kriss Feed](https://tontof.net/kriss/feed/). +FreshRSS is a self-hosted RSS feed aggregator. It is lightweight, easy to work with, powerful, and customizable. @@ -19,21 +19,29 @@ FreshRSS natively supports basic Web scraping, based on [XPath](https://www.w3.o Finally, it supports [extensions](#extensions) for further tuning. -Feature requests, bug reports, and other contributions are welcome. The best way to contribute is to [open an issue on GitHub](https://github.com/FreshRSS/FreshRSS/issues). -We are a friendly community. - * Official website: <https://freshrss.org> * Demo: <https://demo.freshrss.org/> * License: [GNU AGPL 3](https://www.gnu.org/licenses/agpl-3.0.html)  -# Disclaimer +## Feedback and contributions -FreshRSS comes with absolutely no warranty. +Feature requests, bug reports, and other contributions are welcome. The best way is to [open an issue on GitHub](https://github.com/FreshRSS/FreshRSS/issues). +We are a friendly community. + +To facilitate contributions, the following option is available: + +[](https://github.com/codespaces/new?hide_repo_select=true&ref=edge&repo=6322699) + +## Screenshot  +## Disclaimer + +FreshRSS comes with absolutely no warranty. + # [Documentation](https://freshrss.github.io/FreshRSS/en/) * [User documentation](https://freshrss.github.io/FreshRSS/en/users/02_First_steps.html), where you can discover all the possibilities offered by FreshRSS @@ -53,16 +61,12 @@ FreshRSS comes with absolutely no warranty. * Recommended extensions: [GMP](https://www.php.net/gmp) (for API access on 32-bit platforms), [IDN](https://www.php.net/intl.idn) (for Internationalized Domain Names), [mbstring](https://www.php.net/mbstring) (for Unicode strings), [iconv](https://www.php.net/iconv) (for charset conversion), [ZIP](https://www.php.net/zip) (for import/export), [zlib](https://www.php.net/zlib) (for compressed feeds) * MySQL 5.5.3+ or MariaDB equivalent, or SQLite 3.7.4+, or PostgreSQL 9.5+ - -# Releases +# [Installation](https://freshrss.github.io/FreshRSS/en/admins/03_Installation.html) The latest stable release can be found [here](https://github.com/FreshRSS/FreshRSS/releases/latest). New versions are released every two to three months. If you want a rolling release with the newest features, or want to help testing or developing the next stable version, you can use [the `edge` branch](https://github.com/FreshRSS/FreshRSS/tree/edge/). - -# [Installation](https://freshrss.github.io/FreshRSS/en/admins/03_Installation.html) - ## Automated install * [<img src="https://www.docker.com/wp-content/uploads/2022/03/horizontal-logo-monochromatic-white.png" width="200" alt="Docker" />](./Docker/) @@ -83,7 +87,7 @@ If you want a rolling release with the newest features, or want to help testing More detailed information about installation and server configuration can be found in [our documentation](https://freshrss.github.io/FreshRSS/en/admins/03_Installation.html). -## Advice +# Advice * For better security, expose only the `./p/` folder to the Web. * Be aware that the `./data/` folder contains all personal data, so it is a bad idea to expose it. |
