Part 1 — Set up
What you'll do#
- Install the tools the series uses
- Create a project and configure it once
- Run a check that proves the setup works
Steps#
Fill this in with the real install commands for every platform you support. A reader on the platform you left out will assume the series is not for them.
One command, or one small set of files. Say what each generated file is for in a sentence — a reader who knows why a file exists will not delete it in part two.
Name every value the reader must supply, where it comes from, and which ones are safe to leave at the default. Values that must be filled in belong in a table, not in prose.
Run the check below. If it fails, do not continue — Troubleshooting covers the five things that go wrong here.
The check#
# Replace with the command that proves the setup works,
# and show the exact output a reader should see.Show the expected output, not just the command. "It ran" and "it ran correctly" look identical in a terminal until you have something to compare against.
What you have now#
A working environment, and one command you know produces a correct result. That command is what you will use to tell whether part two broke something.