Open taraolivia opened 2 months ago
I suggest we write the draft here!
The entire onenote can also be a longer version of the readme
Added Tailwind guides and purpose, and started on listing built with. Need to add more after Decap CMS is up and running to understand and add that process
Updating README file task should be put back into Backlog for next team as it cannot be completed in the middle of the project❗️
Currently the readme file in musikkforandrerliv.no and mmf-cms-decap repos contains very little information about the project and how to run it. Theres only a small amount of information regarding tailwind in the site repo and just a link to the admin page of the cms repo.
As we saw when we first got introduced to the project there were confusion on tailwind, how to install, if people needed to install it etc. All of this information could be in the readme file.
A good readme file will give a good project overview and be a nice spot to collect important information about the project such as guidelines, usage instructions etc.
Noroff have given an example file for readme, this can be tailored to fit this project but can be a good starting point.