Créer un README avec une installation reproductible.
Un README doit rendre l’installation reproductible depuis des exigences vérifiées. Distinguez les instructions contrôlées des commandes proposées ou configurations indisponibles.
Adaptez le processus à votre tâche.
Utilisez les scripts, prérequis et configurations réels du dépôt pour expliquer installation et premier usage. Distinguez commandes vérifiées et étapes proposées, excluez les secrets des exemples et indiquez clairement comment tester.
- Ce que vous fournissez
- Comportement vérifié du projet et exigences d’installation.
- Ce que vous obtenez
- Documentation avec étapes exécutables à vérifier.
Consultez les données et le résultat.
Entrée et sortie illustratives · exemple pédagogique, pas une exécution WebAct en direct
Exemple champ
Write a minimal README. Fictional project: Tiny Notes. Requires Node 24 and npm, has package-lock.json, scripts dev and test, no environment variables needed for local use.
Exemple complet
# Tiny Notes A small notes application. ## Requirements Node 24 and npm. ## Local setup Install locked dependencies with `npm ci`. Start development with `npm run dev`, then open the URL printed by the development server. ## Tests Run `npm test`. ## Configuration No environment variables are required for local use. These instructions reflect the supplied project facts; no repository execution is claimed.
Chargez ces données dans le prompt, puis copiez-le dans WebAct pour essayer la tâche. Votre résultat peut différer de l'illustration.
Décisions et dépannage.
Un README doit-il inventer une commande d’installation qui paraît classique ?
Vérifiez d’abord le projet. Une commande familière peut être incorrecte pour le gestionnaire de paquets, le fichier de verrouillage ou le processus de build utilisé.
Pourquoi l’installation échoue-t-elle malgré le respect du README ?
Comparez versions d’exécution, configuration requise et scripts réels. Reproduisez l’étape manquante plutôt que d’ajouter un paragraphe vague de dépannage.
Essayez avec votre propre source.
Remplacez l'exemple par vos données dans le prompt. Gardez les exigences nécessaires, puis copiez la tâche dans WebAct.
Personnaliser et copier la tâche ↑