|
|
|
# Project Setup
|
|
|
|
|
|
|
|
All the projects should have a **README.MD** file. Ideally this file should be in english – you never know if and when a foreign third-party will join the project. The goal for the README.MD is to have a clear set of instructions that allows any developer to be able to run the project without requiring any other help.
|
|
|
|
|
|
|
|
## This file must contain updated instructions on:
|
|
|
|
* Required **OS packages** that must be installed in order to run the project
|
|
|
|
* Detailed instructions on how to **run the project for the first time**
|
|
|
|
* How to setup the **sample data**
|
|
|
|
* Documentation URL for the **Icon package**, if any
|
|
|
|
* Any different coding standards and Architectures being used on the project
|
|
|
|
* URL and User/Password info to access the software, if it makes sense for the project
|
|
|
|
* How to run the **Test Suite** |
|
|
|
\ No newline at end of file |