]> git.sur5r.net Git - tio/blobdiff - README.md
New upstream version 2.6
[tio] / README.md
index 7625e85c693371a00ca92f286448fa01f9238574..c935cf9b9db7966de36ac1f34dcfb254a5563fc7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,9 @@
+
+[![tio](images/tio-icon.png)]()
+
 # tio - a simple serial device I/O tool
 
-[![](https://img.shields.io/circleci/build/gh/tio/tio?token=da7e7fd0d0ee99b9f986f8877dcdbe28f73d9e06)](https://circleci.com/gh/tio/tio/tree/master)
+[![](https://img.shields.io/circleci/build/github/tio/tio)](https://circleci.com/github/tio/tio/tree/master)
 [![](https://img.shields.io/github/v/release/tio/tio?sort=semver)](https://github.com/tio/tio/releases)
 [![](https://img.shields.io/repology/repositories/tio)](https://repology.org/project/tio/versions)
 [![](https://img.shields.io/tokei/lines/github/tio/tio)](https://github.com/tio/tio)
@@ -29,7 +32,7 @@ when used in combination with [tmux](https://tmux.github.io).
 
  * Easily connect to serial TTY devices
  * Automatic connect and reconnect
- * Sensible defaults
+ * Sensible defaults (115200 8n1)
  * Support for non-standard baud rates
  * Support for RS-485 mode
  * Support for mark and space parity
@@ -55,6 +58,7 @@ when used in combination with [tmux](https://tmux.github.io).
  * Visual or audible alert on connect/disconnect
  * Remapping of prefix key
  * Man page documentation
+ * Binary size less than 80kB
  * Plays nicely with [tmux](https://tmux.github.io)
 
 ## 3. Usage
@@ -256,9 +260,12 @@ reach out to its package maintainers team.
 
 Install latest stable version:
 ```
-$ snap install tio
+$ snap install tio --classic
 ```
 
+Note: Classic confinement is currently required due to limitations of the snapcraft framework.
+See [Issue #187](https://github.com/tio/tio/issues/187) for discussion.
+
 ### 4.3 Installation using brew (MacOS, Linux)
 
 If you have [brew](http://brew.sh) installed:
@@ -279,7 +286,7 @@ The latest source releases can be found [here](https://github.com/tio/tio/releas
 
 Install steps:
 ```
-$ meson build
+$ meson setup build
 $ meson compile -C build
 $ meson install -C build
 ```
@@ -288,6 +295,15 @@ See meson\_options.txt for tio specific build options.
 
 Note: The meson install steps may differ depending on your specific system.
 
+### 4.6 Known issues
+
+Getting permission access errors trying to open your serial device?
+
+Add your user to the group which allows serial device access. For example, to add your user to the 'dialout' group do:
+```
+$ sudo usermod -a -G dialout <username>
+```
+
 
 ## 5. Contributing