1  ![Banner](./docs/src/images/banner.png)
  2  
  3  ---
  4  
  5  <!-- START doctoc generated TOC please keep comment here to allow auto update -->
  6  <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
  7  <!--**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*-->
  8  
  9  - [ComChan](#comchan)
 10    - [Installation](#installation)
 11      - [From crates.io](#from-cratesio)
 12      - [From source](#from-source)
 13  - [Documentation Link](#documentation-link)
 14    - [Common Commands](#common-commands)
 15      - [Basic Serial Monitor](#basic-serial-monitor)
 16      - [Verbose Mode](#verbose-mode)
 17      - [Log Mode](#log-mode)
 18    - [Features](#features)
 19      - [Legends](#legends)
 20  - [Examples](#examples)
 21    - ["Hello World" Program](#hello-world-program)
 22    - [User Input](#user-input)
 23  - [Feedback Form](#feedback-form)
 24  - [Stargazers over time](#stargazers-over-time)
 25  
 26  <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 27  
 28  # ComChan
 29  
 30  ComChan is a Blazingly Fast Serial monitor for Embedded Systems and Serial Communication. 
 31  
 32  **Latest Version**: 0.1.4
 33  
 34  ## Installation
 35  
 36  ### From crates.io
 37  
 38  
 39  > [!NOTE]
 40  > `cargo install` NOW AVAILABLE
 41  
 42  ```bash
 43  cargo install comchan
 44  
 45  #Install the binary directly
 46  cargo binstall comchan
 47  ```
 48  
 49  After installing, check if it has been installed with
 50  
 51  ```bash
 52  comchan --version
 53  ```
 54  
 55  ### From source
 56  
 57  ```bash
 58  # Clone from GitHub
 59  git clone git@github.com:Vaishnav-Sabari-Girish/ComChan.git
 60  
 61  # Clone from Codeberg
 62  git clone ssh://git@codeberg.org/Vaishnav-Sabari-Girish/ComChan.git
 63  ```
 64  
 65  ```bash
 66  cd ComChan
 67  
 68  cargo build --release
 69  
 70  cargo run
 71  ```
 72  
 73  # Documentation Link
 74  
 75  Documentation Link : https://vaishnav.world/ComChan
 76  
 77  ## Common Commands 
 78  
 79  ### Basic Serial Monitor
 80  
 81  ```bash
 82  comchan -p <port> -r <baud_rate>
 83  
 84  # OR
 85  
 86  comchan --port <port> --baud <baud_rate>
 87  
 88  ```
 89  
 90  ### Verbose Mode
 91  
 92  ```bash
 93  comchan -p <port> -r <baud_rate> -v
 94  
 95  # OR
 96  
 97  comchan --port <port> --baud <baud_rate> --verbose
 98  ```
 99  
100  ### Log Mode
101  
102  ```bash
103  comchan -p <port> -r <baud_rate> -l <log_file_name>
104  
105  # OR 
106  
107  comchan --port <port> --baud <baud_rate> --log <log_file_name>
108  ```
109  
110  For an example log file , get it [here](./test.log)
111  
112  ## Features
113  
114  - [x] Read incoming Serial data from Serial ports
115  - [x] Write to Serial port i.e Send data to Serial device.
116  - [x] Basic logging.
117  - [ ] Write serial data to a file for later use (can be .txt , .csv and more)
118  - [ ] Terminal based Serial Plotter (to be implemented with the `--plot` command)
119  
120  ### Legends
121  
122  - [x] Implemented Features
123  - [ ] Yet to me implemented
124  
125  # Examples
126  
127  ## "Hello World" Program
128  
129  ![GIF](./docs/src/videos/basic_serial_mon.gif)
130  
131  ## User Input
132  
133  ![User IP](./docs/src/videos/basic_user_input.gif)
134  
135  
136  # Feedback Form
137  
138  The Feedback form was created using Bashforms (Forms in the terminal itself). 
139  
140  To give you feedback, please type this on your terminal 
141  
142  ```bash
143  ssh -t bashform.me f comchan
144  ```
145  
146  
147                          
148  # Stargazers over time
149  
150  [![Stargazers over time](https://starchart.cc/Vaishnav-Sabari-Girish/ComChan.svg?variant=dark)](https://starchart.cc/Vaishnav-Sabari-Girish/ComChan)
151  
152