diff --git a/Intellitect.ConsoleView/Readme.txt b/README.md similarity index 58% rename from Intellitect.ConsoleView/Readme.txt rename to README.md index cec428d..bb216af 100644 --- a/Intellitect.ConsoleView/Readme.txt +++ b/README.md @@ -1,15 +1,23 @@ +ConsoleView +=========== + +ConsoleView is a simple end-to-end test framework for .NET console applications. + This currently has non-optimal nomenclature and is not guaranteed to be efficient, but it appears to work. -To use it, use this syntax within a unit test: +Usage +----- +To use it, use this syntax within a unit test: +``` string view = @"Please enter something: <>You said 'Something'."; IntelliTect.ConsoleView.Tester.Test(view, () => { MyMethod() } ); +``` - -The view variable contains a sample view to test for. Within it, the << and >> symbols indicate that the inner content is entered into the console by the user -- including the newline, as they would press Enter. +The view variable contains a sample view to test for. Within it, the `<<` and `>>` symbols indicate that the inner content is entered into the console by the user -- including the newline, as they would press Enter. ... More to come later. \ No newline at end of file