Toutes les ressources premium et membres pour 8,99 €/mois, en abonnement sans engagement. Voir les offres

PalateKit

Se connecter
Menu

Demander une ressource

Décrivez en une phrase la ressource qui vous manque. Nous vous écrirons quand elle sera publiée.

0 / 280

Une page, une vidéo ou une image en ligne.

Débloquer PalateKit

Tout débloquer

Offre

Le paiement vaut acceptation de nos conditions générales de vente.

Paiement sécurisé par Stripe. Reçus et factures envoyés par e-mail.

Content de vous revoir

Connectez-vous pour installer, télécharger ou sauvegarder cette ressource. Un compte gratuit suffit pour les ressources gratuites.

README : rédiger comme une page d'accueil v1.0.0

Utilisez cette ressource pour rédiger un README de projet clair et facile à parcourir

Nouveau

  • 77 téléchargements
  • 198 mentions J'aime
  • 92 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install readme-landing-page-rule

Première fois : connectez la CLI avec

npx --yes palatekit@latest login

Cursor applique ces consignes aux fichiers README : une accroche qui dit ce que fait le projet et pourquoi il compte, un exemple de code dans les cinq premières lignes, des tableaux pour les fonctions, un démarrage rapide sans préfixe $ et une section auteur avec un badge. Elle interdit les formules marketing creuses et vérifie que les images citées existent.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte « README : rédiger comme une page d'accueil »

Caractéristiques

Fonctionne dans
Guides d'installation
Génère avec
Le modèle de votre agent
Licence
CC0-1.0

Ressources similaires

Tout voir

Ce que vous obtenez

  • Le fichier .mdc (en anglais) : consignes de structure et de ton pour les README
  • Des règles pour le démarrage rapide et les visuels du projet

Pour qui

  • Un dépôt open source qui doit convaincre en quelques secondes
  • Un README trop technique à réécrire pour les débutants

Pas pour qui

    Étiquettes

    • readme
    • documentation
    • open source
    • rédaction

    À propos

    Vous dites

    « Réécris le README de ce dépôt avec une accroche et un démarrage rapide. »

    Carte « README : rédiger comme une page d'accueil »

    Rule publié par PatrickJS sous licence CC0-1.0. Fichier livré dans sa version d'origine, en anglais.

    Voir plus

    Comment l'utiliser

    1. Copiez le fichier .mdc dans le dossier .cursor/rules/ de votre projet
    2. Demandez à Cursor de rédiger un README de projet clair et facile à parcourir
    3. Ajustez la règle à vos conventions

    Aperçu du contenu

    Fichiers

    • LICENSE6,5 Ko
    • NOTICE-PALATEKIT.md0,6 Ko
    • readme-landing-page-rule.mdc1,1 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    PatrickJS
    Source
    github.com/PatrickJS/awesome-cursorrules/blob/b044f956f021b6e8877f16781bcfc466a6a120e9/rules/readme-best-practices-cursorrules-prompt-file.mdc
    Licence
    CC0-1.0

    Notice

    « readme-best-practices-cursorrules-prompt-file » (PatrickJS, CC0-1.0) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    Avis des utilisateurs

    –

    Aucune note pour l'instant

    Chargement des avis…

    Supprimer votre avis ?

    Votre note et votre commentaire seront retirés de la fiche.