Skip to content

Commit b1e2211

Browse files
committed
Update main page readme
1 parent ee4d69c commit b1e2211

File tree

1 file changed

+68
-72
lines changed

1 file changed

+68
-72
lines changed

README.md

+68-72
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22

33
## Page Index
44

5-
* [Overview](#overview)
6-
* [Usability](#usability)
7-
* [System Requirements](#system-requirements)
8-
* [Installation Using Makefiles](#installation-using-makefiles)
9-
* [Database, WebMVC, and WebAPI](#database-webmvc-webapi)
10-
* [Advanced Structures, Methods, and Classes](#advanced-structures-methods-and-classes)
11-
* [Intermediate](#intermediate-functions)
12-
* [Basic Functions](#basic-functions)
5+
- [Overview](#overview)
6+
- [Usability](#usability)
7+
- [System Requirements](#system-requirements)
8+
- [Installation Using Makefiles](#installation-using-makefiles)
9+
- [Introductory Logic, Conditions, Loops](#introductory-logic-conditions-loops)
10+
- [Intermediate Structures, Methods and Functions](#intermediate-structures-methods-and-functions)
11+
- [Advanced Structures, Methods, and Classes](#advanced-structures-methods-and-classes)
12+
- [Redis Leaderboard Stable For Testing Purposes](#redis-leaderboard-stable-for-testing-purposes)
13+
- [WSL Neo4J Stable For Testing Purposes](#wsl-neo4j-stable-for-testing-purposes)
1314

1415
## Overview
1516

@@ -44,7 +45,7 @@ At the time of this writing, all example applications were tested on:
4445
## System Requirements
4546

4647
* Supported Operating Systems: `Windows`, `Linux`, `MacOS`
47-
* [Net Core SDK v2.2+](https://dotnet.microsoft.com/download)
48+
* [Net Core SDK v8.0](https://dotnet.microsoft.com/download)
4849
* [VS Code Editor](https://code.visualstudio.com/) is optional but preferred
4950
* Dual Core CPU Minimum
5051
* At Least 1GB RAM
@@ -74,9 +75,9 @@ cases, the invocation command is the same: `make <target>`.
7475
# Install: In the directory you want to test, type the following:
7576

7677
# Windows
77-
make clean
78-
make pack
79-
make install
78+
.\make.cmd clean
79+
.\make.cmd pack
80+
.\make.cmd install
8081

8182
# Linux | MacOSX
8283
make
@@ -91,70 +92,17 @@ LBService
9192
# displayed with instructions to run it.
9293

9394

94-
# Uninstall: Windows, Linux and MacOS
95+
# Uninstall: Windows
96+
.\make.cmd uninstall
97+
.\make.cmd clean
98+
99+
# Uninstall: Linux MacOS
95100
make uninstall
101+
make clean
96102
```
97103

98-
## Database WebMVC WebAPI
99-
100-
`Database, WebMVC, WebAPI` provides examples relating to various database
101-
servers, web technologies, and Application Programming Interfaces (API's). As to their
102-
classification, the examples fall into Advanced category. Setting up the Database
103-
properly, and ensuring the `Usernames and Passwords` match is key to a successful launch.
104-
105-
### Stable For Testing Purposes
106-
107-
These database applications are functional for their intended purpose, e.g. `Testing`. However, none should be considered fully production worthy.
108-
109-
| Application |Database |DB Setup|Status|Description
110-
| :--- |:---|:---|:--- |:---
111-
|[RedisLeaderboard](https://github.com/KI7MT/dotnet-core-examples/tree/master/Database)|Redis|[See Docs](https://github.com/KI7MT/jtsdk-dotnet-core/wiki/Install-Redis)|Stable|Ham Radio Contest Leaderboard Example
112-
113-
### Under Development
114-
115-
The following applications are in various states of development, anywhere from Database Design to final API/MVC integration. The projects may reside in the
116-
repository, but should not be considered functional. As they move from
117-
development to testing, will move up to [Stable for Testing Purposes](#stable-for-testing-purposes)
118-
119-
|Application |Database |DB Setup|Status|Description
120-
| :--- |:---|:---|:--- |:---
121-
|[Rural-Fire-API](https://github.com/KI7MT/dotnet-core-examples/tree/master/Database)|SQL-Server|TBD|Devel|Swagger RESt-API for County Rural Fire Management
122-
|[Rural-Fire-MVC](https://github.com/KI7MT/dotnet-core-examples/tree/master/Database)|SQL-Server|TBD|Devel|Razor WebMVC for County Rural Fire Management
123-
|[WslNeo4J](https://github.com/KI7MT/dotnet-core-examples/tree/master/Database)|Neo4J|TDB|Devel|Movie DB queries using Console App and Neo4j
124-
125-
## Advanced Structures Methods and Classes
126-
127-
`Advanced` applications are a combination of both [Basic](#basic-functions)
128-
and [Intermediate](#intermediate-functions) functions. They may also use instantiation
129-
of classes, interfaces, abstracts, or more advanced
130-
[Object Oriented Programming (OOP)](https://en.wikipedia.org/wiki/Object-oriented_programming)
131-
techniques.
132-
133-
| Application |Type|Description
134-
| :--- |:---|:---
135-
|[EmployeeCommissionV1](https://github.com/KI7MT/dotnet-core-examples/tree/master/Advanced) |various |Calculate commission for one or more employee's
136-
|[EmployeeCommissionV2](https://github.com/KI7MT/dotnet-core-examples/tree/master/Advanced) |various |Uses: Struct, Array of Struct, if-else, loops and methods
137-
|[TikTakToe](https://github.com/KI7MT/dotnet-core-examples/tree/master/Advanced)|various|Game: uses 2D Arrays, if-else, loops, methods, and colors
138104

139-
## Intermediate Functions
140-
141-
`Intermediate` employs things such as [structures](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/struct),
142-
and [methods](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/methods)
143-
outside of the [main method](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/hello-world-your-first-program)
144-
or `(Program.cs`) file.
145-
146-
| Application |Type|Description
147-
| :--- |:---|:---
148-
|[AreaOfCircle](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/methods)|methods|Use methods to calc the Area of a Circle
149-
|[AreaOfTriangle](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/methods)|methods|Use methods to calc the Area of a Triangle
150-
|[CalculatePay](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/methods)|methods|Use methods to calculate Gross Pay
151-
|[InchesToCentimeters](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/methods)|methods|Use methods to Convert In. to Cn.
152-
|[VolumeOfCylinder](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/methods)|methods|Use methods to calc the Volume of a Cylinder
153-
|[JobListing](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/struct)|struct|Use struct to generate job postings
154-
|[MSLListing](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/struct)|struct|Use struct to add to listings array and MLS IDs
155-
|[RandGen](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate)|struct|Advanced Password generator with user input options
156-
157-
## Basic Functions
105+
## Introductory Logic, Conditions, Loops
158106

159107
`Basic Functions` employ things such as [Arrays](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/arrays/),
160108
[for-loops](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/for),
@@ -200,3 +148,51 @@ file. Typically, no other classes are involved apart basic from
200148
|[PowerOff](https://github.com/KI7MT/dotnet-core-examples/tree/master/Introductory/while-loops)|while-loops|Loop that calculates powers of 10 for x < <= 10
201149

202150

151+
## Intermediate Structures, Methods and Functions
152+
153+
`Intermediate` employs things such as [structures](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/struct),
154+
and [methods](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/methods)
155+
outside of the [main method](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/hello-world-your-first-program)
156+
or `(Program.cs`) file.
157+
158+
| Application |Type|Description
159+
| :--- |:---|:---
160+
|[AreaOfCircle](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/methods)|methods|Use methods to calc the Area of a Circle
161+
|[AreaOfTriangle](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/methods)|methods|Use methods to calc the Area of a Triangle
162+
|[CalculatePay](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/methods)|methods|Use methods to calculate Gross Pay
163+
|[InchesToCentimeters](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/methods)|methods|Use methods to Convert In. to Cn.
164+
|[VolumeOfCylinder](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/methods)|methods|Use methods to calc the Volume of a Cylinder
165+
|[JobListing](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/struct)|struct|Use struct to generate job postings
166+
|[MSLListing](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate/struct)|struct|Use struct to add to listings array and MLS IDs
167+
|[RandGen](https://github.com/KI7MT/dotnet-core-examples/tree/master/Intermediate)|struct|Advanced Password generator with user input options
168+
169+
## Advanced Structures Methods and Classes
170+
171+
`Advanced` applications are a combination of both [Basic](#basic-functions)
172+
and [Intermediate](#intermediate-functions) functions. They may also use instantiation
173+
of classes, interfaces, abstracts, or more advanced
174+
[Object Oriented Programming (OOP)](https://en.wikipedia.org/wiki/Object-oriented_programming)
175+
techniques.
176+
177+
| Application |Type|Description
178+
| :--- |:---|:---
179+
|[EmployeeCommissionV1](https://github.com/KI7MT/dotnet-core-examples/tree/master/Advanced) |various |Calculate commission for one or more employee's
180+
|[EmployeeCommissionV2](https://github.com/KI7MT/dotnet-core-examples/tree/master/Advanced) |various |Uses: Struct, Array of Struct, if-else, loops and methods
181+
|[TikTakToe](https://github.com/KI7MT/dotnet-core-examples/tree/master/Advanced)|various|Game: uses 2D Arrays, if-else, loops, methods, and colors
182+
183+
## Redis Leaderboard Stable For Testing Purposes
184+
185+
This application is functional for it's intended purpose, e.g. `Testing`. However, it should not be considered production worthy.
186+
187+
| Application |Database |DB Setup|Status|Description
188+
| :--- |:---|:---|:--- |:---
189+
|[RedisLeaderboard](https://github.com/KI7MT/dotnet-core-examples/tree/master/Database)|Redis|[See Docs](https://github.com/KI7MT/jtsdk-dotnet-core/wiki/Install-Redis)|Stable|Ham Radio Contest Leaderboard Example
190+
191+
192+
## WSL Neo4J Stable For Testing Purposes
193+
194+
This application is functional for it's intended purpose, e.g. `Testing`. However, none should not be considered production worthy.
195+
196+
|Application |Database |DB Setup|Status|Description
197+
| :--- |:---|:---|:--- |:---
198+
|[WslNeo4J](https://github.com/KI7MT/dotnet-core-examples/tree/master/Database)|Neo4J|TDB|Devel|Movie DB queries using Console App and Neo4j

0 commit comments

Comments
 (0)