Documentation: Update the README file
The readme file was created a week ago and should be updated by now. It is now required in assignment deliverables as well. Here is the list of what to include copied from the milestone 4 description:
- README for your project using best practices and containing the
following:
- Headline (Name)
- Project Description
- Feature list
- Demo (Screenshots or Video)
- Link to the up-to-date deployed version of your product
- Usage instructions / Short user guide
- Project Installation / Deployment instructions
- Frameworks or technologies used
- The readme must be well written, meaningful and descriptive.
- Use Gitlab wiki if you need to write extensive documentation.
- MIT licence in your repository and README (if another licence, explain why)
We will use a proprietary or "source available" license. FUTO license is a good example of such license.
Why not MIT or similar license? Our game uses works of art that cannot be subject to the MIT license. Distribution of the game on various platforms will require addition of external code which cannot be subject to the MIT license (example: publishing to Yandex Games requires written transition of ownership, if the game contains in-app purchases). The underlying technology (Unity engine) is proprietary.