-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
43c78b9
commit 2d528b9
Showing
1 changed file
with
8 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,13 @@ | ||
# Introduction | ||
TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project. | ||
|
||
# Getting Started | ||
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about: | ||
1. Installation process | ||
2. Software dependencies | ||
3. Latest releases | ||
4. API references | ||
I've found my self needing one of these repeatedly over the last few months. So I built this one. | ||
|
||
# Build and Test | ||
TODO: Describe and show how to build your code and run the tests. | ||
# Structure | ||
|
||
# Contribute | ||
TODO: Explain how other users and developers can contribute to make your code better. | ||
Name-On consists of 4 components: | ||
|
||
1. name-on-core: A shared library with the core behavior logic | ||
1. name-on-unit-test: A unit testing project for the core library | ||
1. name-on-cli: A command line wrapper for the core library | ||
1. name-on-web: An ASP.NET Core web app surfacing the core behaviors | ||
|
||
If you want to learn more about creating good readme files then refer the following [guidelines](https://www.visualstudio.com/en-us/docs/git/create-a-readme). You can also seek inspiration from the below readme files: | ||
- [ASP.NET Core](https://github.com/aspnet/Home) | ||
- [Visual Studio Code](https://github.com/Microsoft/vscode) | ||
- [Chakra Core](https://github.com/Microsoft/ChakraCore) |