ConsoleLauncher 0.2.0-alpha

ConsoleLauncher

ConsoleLaucher is simple tool for your .NET console application. It allows you to create useful navigation menu, a Live demo here.

Table of Contents

• General Info
• Technologies Used
• Features
• Screenshots
• Setup
• Usage
• Project Status
• Room for Improvement
• Acknowledgements
• Contact

General Information

• Provide general information about your project here.
• What problem does it (intend to) solve?
• What is the purpose of your project?
• Why did you undertake it?

Technologies Used

• Tech 1 - version 1.0
• Tech 2 - version 2.0
• Tech 3 - version 3.0

Features

List the ready features here:

• Awesome feature 1
• Awesome feature 2
• Awesome feature 3

Screenshots

Setup

What are the project requirements/dependencies? Where are they listed? A requirements.txt or a Pipfile.lock file perhaps? Where is it located?

Proceed to describe how to install / setup one's local environment / get started with the project.

Usage

How does one go about using it? Provide various use cases and code examples here.

write-your-code-here

Project Status

Project is: in progress / complete / no longer being worked on. If you are no longer working on it, provide reasons why.

Room for Improvement

Include areas you believe need improvement / could be improved. Also add TODOs for future development.

Room for improvement:

• Improvement to be done 1# ConsoleLauncher

ConsoleLaucher is simple tool for your .NET console application. ConsoleLauncher helps you to create useful and user-friedly navigation menu in just two steps.

Table of Contents

• General Info
• Features
• Get Started
• Screenshots
• Contact

General Information

ConsoleLauncher is a .NET tool, that helps you to create simply, user-friendly console menu. Navigation is handled by using Arrows (alt. PgUp/Down), Enter, Esc.
No longer force your users to write "yes/no". Console Apps are still fun in the XXI century, but make them more user-friendly!

Features / Roadmap

Tool:

• Print menu from options list
• Call method/actions from options list
• Add layout(header/footer) support
• Customize style(colors, keys)

Environment features:

• Add readme
• Automate build process:
  • Build on PR push
  • Automatic publishing to nuget.org
  • Automatic releases

Get Started

Download

Latest version is available always on www.nuget.org/.../ConsoleLauncher

Installation via nuget.org

1. Install latest version

   Install-Package ConsoleLauncher
   

Until project is still released as preview version, please provide specific version, eg:

Install-Package ConsoleLauncher -Version 0.x.x-alpha

Usage

Definition of list of menu entries with actions :

List<Option> options = new()
{
    new Option("Submenu", Submenu),
    new Option("Option 1 as action", Option1),
    new Option("Option 1 as method", () => Option1()),
    new Option("Empty option 2"),
    new Option("Exit", () => Environment.Exit(0)),
};

Initializing menu:

Launcher.Menu(options);

For more examples, please refer to the ConsoleLauncher.Sample

Screenshots

TBD

Contact

Created by Jakub Gramburg (@Jacup) - feel free to contact me!

• Improvement to be done 2

To do:

• Feature to be added 1
• Feature to be added 2

Acknowledgements

Give credit here.

• This project was inspired by...
• This project was based on this tutorial.
• Many thanks to...

Contact

Created by @flynerdpl - feel free to contact me!