Updated README
This commit is contained in:
parent
46bc7347a7
commit
624a838f1a
1 changed files with 38 additions and 16 deletions
54
README.md
54
README.md
|
@ -1,19 +1,41 @@
|
||||||
# Msh-console
|
<!-- vim: set et ts=2 sw=2 tw=80 : -->
|
||||||
Library that provides a bash-like command line for C++ programs. Features included:
|
|
||||||
* included flag handling implemented with popt.h;
|
# msh-console
|
||||||
* creation of personalized commands in the same thread of the shell or in other threads;
|
|
||||||
* basic shell functionalities, such as execution of other programs in the system. This is implemented with execvp().
|
Library that provides a bash-like command line interface for C++ programs.
|
||||||
* piping, implemented with <unistd.h> pipe() function. Code based on http://stackoverflow.com/a/5207730.
|
|
||||||
|
## Abandoned
|
||||||
|
|
||||||
|
This was my first OOP project, so pardon the style and the conventions taken.
|
||||||
|
This project is currently unmantained.
|
||||||
|
|
||||||
|
## Features include:
|
||||||
|
|
||||||
|
* flag handling implemented with `popt.h`;
|
||||||
|
* creation of personalized commands in the same thread of the shell or in other
|
||||||
|
threads;
|
||||||
|
* basic shell functionalities, such as execution of other programs in the
|
||||||
|
system. This is implemented with `execvp()`.
|
||||||
|
* piping, implemented with `<unistd.h>` `pipe()` function. Code based on
|
||||||
|
https://stackoverflow.com/a/5207730.
|
||||||
|
|
||||||
|
## What is not actually included:
|
||||||
|
|
||||||
What is not actually included:
|
|
||||||
* advanced shell features, like:
|
* advanced shell features, like:
|
||||||
* redirection,
|
* redirection,
|
||||||
* scripting,
|
* scripting,
|
||||||
* command history.
|
* command history.
|
||||||
|
|
||||||
### Credits
|
## Credits
|
||||||
Code based on "Write a Shell in C" tutorial by Stephen Brennan (http://brennan.io/2015/01/16/write-a-shell-in-c/).
|
|
||||||
The code has been slightly modified.
|
Code based on
|
||||||
The code contains stringtoargcargv.cpp, a set of functions written by Bernhard Eder (http://web.archive.org/web/20121030075237/http://bbgen.net/blog/2011/06/string-to-argc-argv) for parsing a string into argc and argv.
|
["Write a Shell in C"](http://brennan.io/2015/01/16/write-a-shell-in-c/)
|
||||||
### Compiling
|
tutorial by Stephen Brennan. The code contains `stringtoargcargv.cpp`, a set of
|
||||||
The library can be compiled as shared library with the CMakeLists.txt file already in msh-console-library/.
|
functions written by Bernhard Eder
|
||||||
|
[here](http://web.archive.org/web/20121030075237/http://bbgen.net/blog/2011/06/string-to-argc-argv)
|
||||||
|
for parsing a string into `argc` and `argv`.
|
||||||
|
|
||||||
|
## Compiling
|
||||||
|
|
||||||
|
The library can be compiled as shared library with the CMakeLists.txt file
|
||||||
|
already in `msh-console-library/`.
|
||||||
|
|
Loading…
Reference in a new issue