I will write a clear readme and setup guide for your project

Can a new contributor start your project without asking what to do next?

I will turn your repository and verified setup steps into a clear README or setup guide that another person can follow.

Your documentation can include:

project purpose and scope

prerequisites and supported environment

installation steps

environment-variable names without secret values

run, build, and test commands

expected verification results

troubleshooting notes

known limitations and clearly marked unknowns

I will check the supplied instructions against the provided project where feasible and separate verified steps from assumptions.

Please provide the repository or relevant files, your current README if available, the actual setup/run/test steps, supported OS and runtime versions, and the expected result. Remove passwords, API keys, personal data, and all other secrets before sending.

This service covers documentation and bounded verification. It does not include production deployment, a full code refactor, a formal security audit, or a guarantee that every environment will behave identically.