CONTROLLED DATA
Leidos Proprietary - US Citizens ONLY
The information contained herein is proprietary to Leidos, Inc. It may not be used, reproduced, disclosed, or exported without the written approval of Leidos.
The README.md (markdown markup) file is used to describe the files in a directory, archive, or repository. This page contains guidelines to enhance the ability for users to search for and understand how to use your code through rich README.md files. To support adoption and user understanding, wherever possible, provide examples.
If your code does not have README.md files already, you must comply with the minimum document requirements.
Add a logo here, if desired.
Project Title
Add internal titles used
Provide a summary; keep it short.
Features
Describe the objective of the code or what problem it solves. Why was it written? What makes this code useful?
If there is a site where the code can be demonstrated, add that detail here.
Technologies
List the technologies used, the libraries, and its versions.
Design Decisions, Justification, & Issues
Describe any design decisions, justification, or known issues
Define the scope of the technology; what it does and what it does not do
Installation & Deployment
Prerequisites
Describe any prerequisites or assumptions for the use of this code
Steps
Provide command line instructions, provide examples, screen captures, etc.
Any details that make it easier for the user to be successful
Include deployment steps if applicable.
Tests
Describe how to test the installation
Credits
List the authors and contributors or a POC for technical contact
Copyright Notice, License & Usage Restrictions
Add any copyright notices, licensing information, or usage restrictions