tags:
- Csharp
- example
Description: Put a meaningful, short, plain-language description of:
- What this project is trying to accomplish
- Why it matters. Describe the problem(s) this project solves.
Other things to include:
- Technology stack: Indicate the technological nature of the software, including primary programming language(s) and whether the software is intended as standalone or as a module in a framework or other ecosystem.
- Status: InDevelopment or Done. It's OK to write a sentence, too. The goal is to let interested people know where this project is at.
- Any Link to production or demo instances
Screenshot: If the software has visual components, place a screenshot after the description; e.g.,
Describe any dependencies that must be installed for this software to work. This includes programming languages, databases or other storage mechanisms, build tools, frameworks, and so forth. If specific versions of other software are required, or known not to work, call that out.
| Name | Type | Source | Version | Description | Links | Notes |
|---|---|---|---|---|---|---|
| numpy | package | pip | 1.23.1 | NumPy is the fundamental package for array computing with Python. | https://pypi.org/project/numpy/ | Extra notes |
| MSSQL Server | database | pip | 1.23.1 | MsSql Server is our database of choice | https://www.microsoft.com/en-us/sql-server/sql-server-downloads | Extra notes |
Detailed instructions on how to install the project are written in a separate INSTALL document.
Detailed instructions on how to configure the project are written in a separate INSTALL document.
Show users how to use the software. Be specific. Use appropriate formatting when showing code snippets.
TODO: Give some examples.
You can also refer to specific samples inside the samples folder.
TODO: link to documentation
If you want to get involved, run tests or use the code of the project, please refer to this CONTRIBUTING document. You should also follow the STRUCTURE document to understand how we manage C# project.
Instruct users how to get help with this software; This might include links to an issue tracker, wiki, mailing list, etc. The Lead in charge of the project should be referenced here for help.
Example
If you have questions please contact :
- Tech Lead Name: techlead@mail.com
- The team
- Related projects
- Books, papers, talks, or other sources that have meaningful impact or influence on this project