build-markdown-template

[mlr77]

Add a jekyll template or similar and started adding documentation based on completed issues.

At least get started and create the template with the following headers.

• [x] Motivation. This section explains why the project exists. What problem(s) is it hoping to address?

• [x] Goals. What are the desired capabilities of the technology? How can someone know if the project is helping to address the problem(s)?

• [x] Usage. This section provides an overview of the current status of the technology associated with the project. It should include screenshots for all implemented screens of the app. Provide descriptive text with each screenshot and build a narrative. (This section will get progressively more detailed with each release of your app.)

• [x] Installation. This section should provide a link to the repo containing your code, and instructions on how to install and run it. (At this point, it’s basically just download and invoke flutter run. Later, when there is a backend database, these instructions will become more complicated. Some projects may also need people to obtain API keys if you are using third party services such as Google Maps or weather services.) Note that your repo, at this point, should be public.

• [x] Development status. This section should provide a link to your Project Board.

• [x] About us. This section should introduce all of the team members.

[mlr77]

The basic markdown is there. I think this just needs a bit more work.