- Added a header images for the "root" based documents for GitHub related stuff.
- Edited files which include the new header image to reflect the doc's structure change.
- Improved the images included in README.md.
- General proof reading
The images should help improve the readability of the documents. And, they have begun to settle on a style which compliments the GitHub styling. This should be use for the Wiki part of the project.
- Added links to CONTRIBUTING.md
- Spelling and grammar changes pages above.
The documents still need more proof reading and editing. With that said, the guides are the only significant thing left to add to this project. Once that is done, it will mostly be a case of fine tuning stuff for version 1.0.
Added PULL_REQUEST_TEMPLATE.md.
Change ISSUE_TEMPLATE to BUG_REPORT_TEMPLATE.md.
Minor refactoring to some files - spelling and grammar.
Changes to BUG_REPORT_TEMPLATE to seperate meaning from PULL_REQUEST. The title ISSUE_TEMPLE could still apply to PULL_REQEST. They are in a good position for linking to the CONTRIBUTING.md file now.
Decomposed constructor
Reduced comments
The aim was to increase the readability of the code with less need for comments. I believe the code is now more readable but time will tell I guess.
Renamed several variables.
Edited several comments.
I am still not entirely happy with the readability of this code. But, I am hopefull it is something which can be read and understood with some degree of ease.
Elabourated on comments already in Command.cs.
Added new comments to Command.cs.
I added these comments because I do not think the code is as readable as it can be here. I think I need to go in a refactor it a bit more, so it is a little easier to read.
Removed "Command'X'" naming convention.
Added basis verb-like naming convention.
I changed the naming convention and altered the commands offered to make the console program demonstrate more realistic scenarios. They are still very basic, however.
This is in preparation of writing unit tests involving the CW_Console test-methods. I have added nothing to the unit test project, as of yet. Please check future commits for this unit test project because I am not sure it will remain at this moment in time. It all depends on how well the testing works out -- in the way I have it set-up right now at least.
Each command takes in a single and different parameter from the rest. This is in preparation for the addition of unit tests. I am unsure if the inclusion of unit tests will remain in this form at the moment. So, please check future commits before assuming they are still there.
Wrote a large chunk of the README file. It still needs links added to it and proof read but the bulk of it is there. I, also, made minor changes to the code for readability purposes.
Code of conduct and contribution pages are yet to be started.
The solution now has a working version of the class library on the console program. The console program is now setup, as well. I have not implemented the Help section properly in the console program yet. But, it is wired up and awaiting the addition of the attributes to the command-methods.
CraigOates