Browse Source

update ReadMe for GitLab port.

master
Craig Oates 4 years ago
parent
commit
2d171a8be0
  1. 100
      README.md

100
README.md

@ -1,96 +1,58 @@
# ![Logo](Documentation/GitHub_Assets/Page-Header.png "Header")
# Summary
## About Console.Waterworks.Core
Console.Waterworks.Core is the .Net **Core** version of Console.Waterworks. Both projects are NuGet packages and their main purpose is to help you write extendable command-based console programs. If you want to write a console program using the full .Net Framework, use Console.Waterworks. The link for that is as follows:
Console.Waterworks.Core is the .Net Core version of Console.Waterworks. Both projects are Nuget packages. And, their main purpose is to help you write extendable command-based console programs. If you want to write a console program using the full .Net Framework, use Console.Waterworks.
- [Console.Waterworks Repository](https://gitlab.com/craig.oates/Console.Waterworks)
**[Console.Waterworks Repository](http://www.github.com/CraigOates/Console.Waterworks)**
## About Documentation
In this repository, you will find instructions on how to **use** Console.Waterworks.Core. This is because the architecture and concepts between the two projects are the same. So, it felt unnecessary to repeat that part here. Instead, I will point you to the Console.Waterworks' wiki. Once there, you can explore how they are built.
Please note, the code examples used in the wiki are the **same** for both repositories. Also, the wiki's main focus is on explaining the architecture and concepts of the projects. So, you will not find a lot of code samples in it. If you want to explore the code, I recommend you start in the class called `CW_Liaison`. It is the entry point (for both projects).
**[Console.Waterworks Wiki - Artictecture Overview](https://github.com/CraigOates/Console.Waterworks/wiki/Architecture-Overview)**
### Pre-Requisites
## Pre-Requisites
To use Console.Waterworks.Core, I recommend you meet the following pre-requisites:
- You have experience with [C#](https://docs.microsoft.com/en-us/dotnet/csharp/).
- You can create a [.Net console program](https://docs.microsoft.com/en-us/dotnet/core/tutorials/with-visual-studio) in [Visual Studio 2017](https://www.visualstudio.com/vs/).
- You have experience with [Nuget](https://www.nuget.org/).
- You have Microsoft [.Net Framework 4.7](https://docs.microsoft.com/en-us/dotnet/framework/install/guide-for-developers) or higher.
- You can create a [.Net console program](https://docs.microsoft.com/en-us/dotnet/core/tutorials/with-visual-studio) in [Visual Studio 2017+](https://www.visualstudio.com/vs/).
- You have experience with [NuGet](https://www.nuget.org/).
- You have experience with [.Net Core 2.1](https://dotnet.microsoft.com/download/dotnet-core/2.1).
### Quick Start - Wiring Console.Waterworks.Core in to your Console Program
## Console.Waterworks.Core (Library/NuGet Package)
Before continuing... I am skipping the part about creating a .Net console program. This is because I assume you know how to do that. I am, also, assuming you are using Visual Studio 2017 and C# (not VB or F#).
1 Add Console.Waterworks.Core to your project via Nuget. You can do this using Visual Studio's (2017) Package Manager GUI. Or, you can use the Package Manager Console. Here is the command for the PM Console,
This is a .Net Core 2.0 library and I wrote it in C#. This is what you will add to your project when you want to add the features of this codebase into yours. To add it to your project, use the following command in your Package-Manager console (assuming Visual Studio),
```powershell
# Enter the version of number of your choice.
Install-Package Console.Waterworks.Core -Version 0.1.0-alpha1
// Make sure you change the version number to match the one you want.
Install-Package Console.Waterworks.Core -Version 1.0.0.1
```
2 Create a class called `ConsoleCommands`. It can go anywhere as long as it is in the same project as the console program.
3 Make a note of the `ConsoleCommands` namespace.
4 Head to the `Main` method in `Program.cs` and add the following lines of code,
```c#
public static void Main(string[] args)
{
CW_Liaison liaison = new CW_Liaison();
liaison.Run("CW_Console", true);
}
```
If you are using the .Net CLI, use the following command,
5 Head back to `ConsoleCommands` and make it public and static.
6 Stay in `ConsoleCommands` and write the following method,
```c#
public string Test()
{
return "Congratulations! It works.";
}
```powershell
// Again, make sure you change the version number to the one you want.
dotnet add package Console.Waterworks.Core --version 1.0.0.1
```
7 Run the program and type "Test" into the console.
8 If all has gone well, you should see the “Congratulations! It works." message.
9 Add more methods to you console program.
For more information, please use the following links:
### (Offline) Guides
- [Console.Waterworks.Core Wiki](https://gitlab.com/craig.oates/Console.Waterworks.Core/wikis/home)
- [NuGet Profile Page](https://www.nuget.org/packages/Console.Waterworks.Core/)
I provided a link to Console.Waterworks' Wiki as a online guide for learning about Console.Waterworks(.Core)'s architecture. With that said, I have, also, mad a couple of guides for when you are offline. The are as follows,
## CW_Core_Console
- The Quick Guide to Console.Waterworks.Core
- The Architecture Guide Console.Waterworks.Core
This is a .Net Core console program which provides a working example of how Console.Waterworks.Core works. You can use this as a reference to help you familiarise yourself with how to add Console.Waterworks to your project. This is written in C#.
These guides are printer friendly. And, they are best consumed on your favourite reading chair.
## CW_Core_Tests
### Code of Conduct
This is a .Net Core library which tests houses the projects unit tests. This is written in C# and uses xUnit as its testing framework/library/situation/whatever-you-want-to-call-it.
Please visit the Code of Conduct page for Console.Waterworks.Core at,
## About the Creator
- [Code of Conduct page](https://github.com/CraigOates/Console.Waterworks.Core/blob/master/CODE_OF_CONDUCT.md)
- [MIT License](https://github.com/CraigOates/Console.Waterworks.Core/blob/master/LICENSE)
### Contributing to the Console.Waterworks.Core Repository
Please visit the Contributing page for Console.Waterworks.Core at,
Hi, my name is Craig and I'm the creator of Console.Waterworks.Core. Thanks for checking it out.
- [Contributing page](https://github.com/CraigOates/Console.Waterworks.Core/blob/master/CONTRIBUTING.md)
- Email: [craig@craigoates.net](mailto:craig@craigoates.net)
- Web: [craigoates.net](http://www.craigoates.net)
- Project's Site: [craigoates.net/software/project/8](www.craigoates.net/Software/project/8)
### About the Creator
## A Note about Console.Waterworks.Core Wiki
Hi, my name is Craig and I'm the creator of Console.Waterworks.Core. Thanks for checking it out.
This repository's wiki focuses on how-to **use** Console.Waterworks.Core. This is because the architecture and concepts between this and its sister project (Console.Waterworks) are the same. And, it felt unnecessary to repeat what I wrote in the wiki for Console.Waterworks here. So, if you want information on how Console.Waterworks(.Core) is built, I recommend you glance over the wiki here and then head over to the main wiki at Console.Waterworks. The link for both is as follows:
- Email:craig@craigoates.net
- Web: [http://www.craigoates.net](http://www.craigoates.netk)
- Project's Site: [http://craigsappshed.azurewebsites.net/Waterworks](http://craigsappshed.azurewebsites.net/Waterworks "Project's site") (Subject to change)
- [Console.Waterworks.Core Wiki](https://gitlab.com/craig.oates/Console.Waterworks.Core/wikis/home)
- [Console.Waterworks Wiki](https://gitlab.com/craig.oates/Console.Waterworks/wikis/home)
Loading…
Cancel
Save