Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Redesign of readme (first step).
  • Loading branch information
EvilLord666 authored Nov 14, 2017
1 parent 6b1bb63 commit 026b6bd
Showing 1 changed file with 23 additions and 9 deletions.
32 changes: 23 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
# EasyCli
A cross-platform command line arguments parser and checker
This is a overview about library usage:
https://github.com/IzyaSoft/EasyCli/wiki/How-to-use-EasyCmdLineReader-library
# 1. EasyCli OVERVIEW
A cross-platform command line tool (reading arguments from command line and getting values as string, int or double by key).
Argumnets could be passed either in windows or linux style with possibility to choose separator (i.e. space or =)
`
Linux Style

This is a full example :
https://github.com/IzyaSoft/EasyCli/wiki/Full-usage-example
./myapp --port=com6 --baudrate=115200 --parity=even --stopbits=2 --flowcontrol=cts
./myapp -if infile.txt -of outfile

Windows Style

Nuget package (4 use library in visual studio) :
https://github.com/IzyaSoft/EasyCli/wiki/Nuget-package
package in nuget.org - EasyCmdLineReader
.\myapp.exe \ipAddress 192.168.10.43 \port 4543 \settings mysetting.xml
`
# 2. PROJECT STRUCTURE, TOOLS AND DEPENDENCIES

# 3. USAGE EXAMPLE

# 4. NUGET PACKAGE

https://www.nuget.org/packages/EasyCli/
Example of how to use could be found in MSVS (project for Visual Studio 2013) -> EasyCliNugetExample

# 5. CONTRIBUTORS
EvilLord666 (Ushakov Michael)
VeryNiceGuy (Alex Petrov)

0 comments on commit 026b6bd

Please sign in to comment.