Moving README to markdown

This commit is contained in:
Bryan Stansell 2019-03-18 19:26:28 -07:00
parent fc94056635
commit 043a43225b
2 changed files with 45 additions and 39 deletions

39
README
View File

@ -1,39 +0,0 @@
README
======
Maintainer/Enhancer
Bryan Stansell (bryan@conserver.com)
Overview
Conserver is an application that allows multiple users to watch a
serial console at the same time. It can log the data, allows users to
take write-access of a console (one at a time), and has a variety of
bells and whistles to accentuate that basic functionality. The idea is
that conserver will log all your serial traffic so you can go back and
review why something crashed, look at changes (if done on the console),
or tie the console logs into a monitoring system (just watch the
logfiles it creates). With multi-user capabilities you can work on
equipment with others, mentor, train, etc. It also does all that
client-server stuff so that, assuming you have a network connection,
you can interact with any of the equipment from home or wherever.
Documentation
See the INSTALL file for installation and the man pages for specifics.
Downloading
The latest version can be found via http://www.conserver.com/ or
directly from https://github.com/conserver/conserver/.
Contributions
Contributions distributed with the code can be found in the contrib
subdirectory.

45
README.md Normal file
View File

@ -0,0 +1,45 @@
[![Build Status](https://api.cirrus-ci.com/github/conserver/conserver.svg)](https://cirrus-ci.com/github/conserver/conserver)
README
======
Maintainer/Enhancer
-------------------
Bryan Stansell (bryan@conserver.com)
Overview
--------
Conserver is an application that allows multiple users to watch a
serial console at the same time. It can log the data, allows users to
take write-access of a console (one at a time), and has a variety of
bells and whistles to accentuate that basic functionality. The idea is
that conserver will log all your serial traffic so you can go back and
review why something crashed, look at changes (if done on the console),
or tie the console logs into a monitoring system (just watch the
logfiles it creates). With multi-user capabilities you can work on
equipment with others, mentor, train, etc. It also does all that
client-server stuff so that, assuming you have a network connection,
you can interact with any of the equipment from home or wherever.
Documentation
-------------
See the INSTALL file for installation and the man pages for specifics.
Downloading
-----------
The latest version can be found via http://www.conserver.com/ or
directly from https://github.com/conserver/conserver/.
Contributions
-------------
Contributions distributed with the code can be found in the contrib
subdirectory.