Skip to content

Commit

Permalink
Updated readme, added example diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
lnarolski committed May 1, 2022
1 parent 652f957 commit f772939
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
1 change: 1 addition & 0 deletions ExampleDiagram.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile host="Electron" modified="2022-05-01T18:00:58.598Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.4.3 Chrome/87.0.4280.141 Electron/11.3.0 Safari/537.36" etag="O2y01nvsuFVBXAbo63XX" version="14.4.3" type="device"><diagram id="PcO2FRO8VxHNA4oTNnsg" name="Strona-1">7Zldb5swFIZ/DZerMA4huWySdrupNDWa1u7OBQesGoyME8h+/Q7BhM8obZeGKBsXyH6xD/Z7nhhMDDwPs6+SxMGD8Cg3LNPLDLwwLGs6QXDOhW0h2GOnEHzJvEJClbBkv6kWTa2umUeTRkMlBFcsboquiCLqqoZGpBRps9lK8OZdY+LTjrB0Ce+qP5mngkLFtlnp3yjzA31nbOoLISnbaiEJiCfSmoTvDDyXQqiiFGZzynPrSluKfvcHru7HJWmk3tLhAT0+Yie0sl9xOo9fUxdPn7/oKBvC13q+EMCjGzgrtf2xnJWDV9vSECnWkUfzoKaBZ2nAFF3GxM2vpkAAaIEKOdQQFHV4KhXNDo4b7d0AiKgIqZJbaKI7lE5rflDpZ1plY68FtUyMtUY0AP4+cmUSFLRP7/DMOuxZrBI4O4N7hkdN0wb3DB/zbHJxng0P2uiYadOLM2140uwe01om0ci7zZ8MUHM5SRLmghmJIlJ15ZpdNGPqqVZ+rpUXmbZ8V9mWlQhm9FSv5H3MG7usVt12tbJfMWLqdZ5MrbTArMRauvT4Ag+T86k6xlo3zbU02j1ZLDVJOVFs0xxuX2r1Hb4LBhPZU2S1KZq06CimqXvVn3HtQNNWINwKVPjQCbQjbT/tj8M3Pit8GqRrwA9fEn6ovTh9FD+Ezoufc178rgU+a1D4rAOvHe+Gz2kGcs7L3uSilr4TUjQoHXaLjo8+GO1xM459XjhQ3z7z8ukYKuujVrbQaHrjmNPqmJyGgmNxP5uKvp30fyreSoWVZw+Z1TE6DRXH4n42Fd1vBbdxjDpkwKZVNZOeKCle6VxwIUGJRAQtZyvGeUsinPlRTg7klYI+y7fAzCX8Vl8Imeflt+ndQDe32Mbf76HtSdP/8m20RtWoh6r2e8LJdtCo+91hQV/WPmTBsMY8N/1FQslXu/nfd8VlxFYrKncd/pWsocHT1v3yAQnorqhXm4FP/OFAtfpQXyx01Z8d+O4P</diagram></mxfile>
Binary file added ExampleDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,37 @@

# TtyCloner
Clone tty device to few pseudo ttys without worrying about blocking cloned device

# Table of contents

* [General info](#general-info)
* [Diagram](#diagram)
* [Compilation/Installation](#compilation/installation)
* [Example](#example)
* [Example diagram](#example-diagram)
* [Build](#build)
* [Example of use](#example-of-use)

# General info

TODO
You should run this application with root permissions or give permissions to needed devices/directories.

# Diagram
# Example diagram

TODO

# Compilation/Installation
# Build

Commands to build on clean Debian 10 VM:

sudo apt update
sudo apt install git cmake g++ -y
git clone https://github.com/lnarolski/TtyCloner
cd TtyCloner
mkdir build
cd build
cmake ..
make

After compilation use TtyCloner binary file. You can also open and compile this project in Microsoft Visual Studio from TtyCloner.sln file.

# Example
# Example of use

TODO

0 comments on commit f772939

Please sign in to comment.