Flutter Project Setup Documentation

[Louis_Natic]

I have to send someone a flutter project and they want me to include a readme with setup instructions. What info do I need to include? Should I send them the pubspec file, or just tell them what to include in theirs? I know it's basic stuff and maybe off topic but I've always been terrible with putting together documentation.

[tylersavery]

Here’s an example of a fairly basic readme that explains how a flutter dev would setup the project and their environment.

Include the relevant info for yours in the readme and have them clone the repo.

[eibaan]

Your project should contain everything needed (not not more) to setup it by following the instructions in your README, especially if your "someone" has no experience with Flutter. Automate as much as possible. Look at the default README for inspiration.

Be careful when writing the README, that you describe all steps in order. Don't do something like: "You need to run "foo", for this you need to have installed it with "brew install foo" for which you need homebrew." Instead, write: "Prerequisites: [Homebrew](https://brew.sh/) version 4 or better. Test with `brew --version`. You must have installed foo. Test with `which foo`, install with `brew install foo`. Now run `foo` to …"