Write the README and the installation documentation of a project

The situation

Documentation is the first thing missing when a project changes hands. An agent who has access to the repository can deduct the actual commands, the environment variables and the structure, and then verify that the instructions work by executing them.

Before you start

Tool cited: Claude Code; the prompt also works with Codex and GitHub Copilot. Gather the information the prompt asks for. Strip confidential data that is not needed and check your tool’s access terms. Features and plans can change.

The method, in three steps.

1. 01

   Gather the context

   Gather the information described in the prompt.

2. 02

   Adapt the prompt

   Copy the prompt below, replace the bracketed items, then paste it into Claude Code, Codex or GitHub Copilot.

3. 03

   Reread before using

   Reread the result, correct it if needed and keep the final decision. Caveats are detailed below.

Your starting point.

Replace the bracketed items, then adapt the proposal to your situation. This prompt is written by the iadujour desk.

Read this repository and write a README.md in French:
- what the project is for (3 sentences)
- prerequisites
- installation and launch (accurate controls)
- environment variables (with fictitious examples)
- how to run the tests
- folder structure
Runs each installation command in a clean environment and fixes the README if a step fails. Report what you couldn't verify.

What deserves your attention

Useful skills

Official skills on the same task, paired by the desk: they are not part of the described case.

• Build an application with SDK GitHub CopilotMicrosoft · Guides the creation of applications that rely on GitHub Copilot via the Copilot SDK, for programmatic integrations in Node.js/TypeScript, Python, Go or .NET: sessions, custom tools, streaming, hooks, MCP servers, BYOK providers, persistence, agents and skills, and deployment schemes.
• Create an MCP server and widgets for Copilot ChatMicrosoft · To build MCP servers for Copilot Chat, with widgets rendering (OpenAI Apps SDK or MCP Apps SDK, any language), including React and Fluent UI widgets and tools that return structuredContent.
• Create a reporting agent M365 Copilot or TeamsMicrosoft · Creates, assembles, deploys, and locates reporting agents for M365 Copilot and Teams: scaffolding, editing demonstrations, adding capabilities or plugins.