create CLI Project Breakdown.

master
Craig Oates 5 years ago
parent
commit
d1ad5ffe32
  1. 22
      CLI-Project-Breakdown.md
  2. 6
      Home.md
  3. 6
      Source-Code-Home.md
  4. 6
      _sidebar.md

22
CLI-Project-Breakdown.md

@ -0,0 +1,22 @@
The project's main purpose is to expose the features in WetPancake (the NuGet package) to those not wanting to writing code.
WetPancakeCLI is a traditional .Net (4.7) console program, written in C#. Having said that, there are part which reference F#-specific code. So, if you have not worked with F# before, there might be some lines of code which look a little unusual. If you would like to know more about my language/design choices, you can do so by using the following link:
- [Introduction to Wet Pancake](Introduction-to-WetPancake)
If the idea of mixing C# and F# is off-putting for you, do not worry. I have isolated the F# parts and provided comments in the code to help you spot and work with it. Having said that, if you have no F# experience, working with the other two projects is most likely out of the question.
Within WetPancakeCLI, you will see six files and two folders.
FILE STRUCTURE BREAKDOWN.
"Packages.config", "WetPancakeCLI.csproj" and "App.config" are all standard files found within a Visual Studio project like this. I can, also, say the same for the "Properties" folder and its contents, which is a file called "AssemblyInfo.cs". Therefore, I will not spend too much time on them. If are you are new to .Net, C# or programming in-general, I recommend the following links:
- [.Net](https://dotnet.microsoft.com/)
- [C# for Absolute Beginners](https://channel9.msdn.com/Series/C-Fundamentals-for-Absolute-Beginners)
**Note:** While the "logo.ico" file/icon is relevant, it is also a fixed asset. Because I have already created it and added it to the project, it does not need modifying. For the sake of clarity, it is the icon you see in the task bar and File Explorer.
This leaves "ConsoleCommands.cs", "Program.cs" and the contents in "ProductInfo" -- which is a file called "quick-guide.pdf".
IMAGE OF FILES WITH HIGHLIGHTING OF RELEVANT FILES.

6
Home.md

@ -39,6 +39,12 @@ Before continuing, I recommend you are familiar with the following:
### WetPancakeCLI
- [WetPancakeCLI Home](WetpancakeCLI-Home)
- [C.L.I. Project Breakdown](CLI-Project-Breakdown)
- [The C.L.I's Flow](The-CLIs-Flow)
- [Creating the Input-Loop](Creating-the-Input-Loop)
- [Command-Methods Overview](Command-Methods-Overview)
### TestCentre
- [TestCentre Home](TestCentre-Home)

6
Source-Code-Home.md

@ -9,6 +9,12 @@ This section is for those wanting to work with the repositories source code. If
### WetPancakeCLI
- [WetPancakeCLI Home](WetpancakeCLI-Home)
- [C.L.I. Project Breakdown](CLI-Project-Breakdown)
- [The C.L.I's Flow](The-CLIs-Flow)
- [Creating the Input-Loop](Creating-the-Input-Loop)
- [Command-Methods Overview](Command-Methods-Overview)
### TestCentre
- [TestCentre Home](TestCentre-Home)

6
_sidebar.md

@ -15,6 +15,12 @@
### WetPancakeCLI
- [WetPancakeCLI Home](WetpancakeCLI-Home)
- [C.L.I. Project Breakdown](CLI-Project-Breakdown)
- [The C.L.I's Flow](The-CLIs-Flow)
- [Creating the Input-Loop](Creating-the-Input-Loop)
- [Command-Methods Overview](Command-Methods-Overview)
### TestCentre
- [TestCentre Home](TestCentre-Home)

Loading…
Cancel
Save