Skip to content

Commit

Permalink
Readme and requirements.txt update
Browse files Browse the repository at this point in the history
Signed-off-by: Mehmet Cagri Aksoy <mcagriaksoy@yandex.com>
  • Loading branch information
Mehmet Cagri Aksoy committed Oct 23, 2023
1 parent 28ebfa2 commit 7783fc9
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 11 deletions.
30 changes: 22 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
The AFCOM (aka Serial communication GUI program) tool is a software application that allows users to send and receive data via the serial port (COM port) of their computer.
The AFCOM (aka Serial communication GUI program) tool is a software application that allows users to send and receive data via the serial port (COM port) of their computer.
The tool can be used for various purposes, such as testing, debugging, or communicating with other devices that use the serial protocol.


<a href="https://github.com/mcagriaksoy/Serial-Communication-GUI-Program" title="Go to GitHub repo"><img src="https://img.shields.io/static/v1?label=mcagriaksoy&message=Serial-Communication-GUI-Program&color=blue&logo=github" alt="mcagriaksoy - Serial-Communication-GUI-Program"></a>
<a href="https://github.com/mcagriaksoy/Serial-Communication-GUI-Program/releases/"><img src="https://img.shields.io/github/tag/mcagriaksoy/Serial-Communication-GUI-Program?include_prereleases=&sort=semver&color=blue" alt="GitHub tag"></a>
<a href="#license"><img src="https://img.shields.io/badge/License-MIT-blue" alt="License"></a>
<a href="https://github.com/mcagriaksoy/Serial-Communication-GUI-Program/issues"><img src="https://img.shields.io/github/issues/mcagriaksoy/Serial-Communication-GUI-Program" alt="issues - Serial-Communication-GUI-Program"></a>
[![OS - Linux](https://img.shields.io/badge/OS-Linux-blue?logo=linux&logoColor=white)](https://www.linux.org/ "Go to Linux homepage")

[![Hosted with GH Pages](https://img.shields.io/badge/Hosted_with-GitHub_Pages-blue?logo=github&logoColor=white)](https://pages.github.com/ "Go to GitHub Pages homepage")
[![OS - Windows](https://img.shields.io/badge/OS-Windows-blue?logo=windows&logoColor=white)](https://www.microsoft.com/ "Go to Microsoft homepage")

## Features

The COM port tool has the following features:

It supports multiple COM ports and can detect the available ports automatically.
Expand All @@ -19,10 +18,23 @@ It provides a user-friendly interface that shows the transmitted and received da
It allows users to save and load the data to and from files.

## Usage
The COM port tool is compatible with Windows/Unix/Linux.

The COM port tool is compatible with:
[![OS - Linux](https://img.shields.io/badge/OS-Linux-blue?logo=linux&logoColor=white)](https://www.linux.org/ "Go to Linux homepage")
[![OS - Windows](https://img.shields.io/badge/OS-Windows-blue?logo=windows&logoColor=white)](https://www.microsoft.com/ "Go to Microsoft homepage")

To use the tool, follow these steps:
First of all, please ensure that you installed dependencies already.

```
python main.py
```

Then the project can be run with:

```
pip install -r requirements.txt
```

![Project](https://github.com/mcagriaksoy/Serial-Communication-GUI-Program/blob/master/img/screenshot.jpg)

Expand All @@ -32,8 +44,12 @@ Make sure that the COM port is not used by another application or device.
Make sure that the parameters of the serial communication match with those of the device you are communicating with.
Make sure that you have sufficient permissions to access the COM port.
If you have any questions or feedback, please contact me.

## Dependencies
[![PyQt - > 6.0](https://img.shields.io/badge/PyQt->_6.0-2ea44f)](https://wiki.python.org/moin/PyQt)

[![PyQt - >= 6.0](https://img.shields.io/badge/PyQt->_6.0-2ea44f)](https://wiki.python.org/moin/PyQt)
[![PyQt_sip - >= 13.0](https://img.shields.io/badge/PyQt_sip->_13.0-2ea44f)](https://pypi.org/project/PyQt6-sip/)
[![PySerial - >= 3.0](https://img.shields.io/badge/PyQt->_3.0-2ea44f)](https://pypi.org/project/pyserial/)

<h2>Documentation</h2>
<div align="center">
Expand All @@ -42,5 +58,3 @@ If you have any questions or feedback, please contact me.
</div>
<h2>License</h2>
Released under <a href="/LICENSE">MIT</a> by <a href="https://github.com/mcagriaksoy">@mcagriaksoy</a>.
Many Thanks to JulianRene also!

1 change: 1 addition & 0 deletions myenv/bin/python
1 change: 1 addition & 0 deletions myenv/bin/python3
1 change: 1 addition & 0 deletions myenv/bin/python3.10
1 change: 1 addition & 0 deletions myenv/lib64
3 changes: 3 additions & 0 deletions myenv/pyvenv.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
home = /usr/bin
include-system-site-packages = false
version = 3.10.12
11 changes: 8 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
PyQt6==6.5.2
PyQt6_sip==13.4.0
pyserial==3.5
# Project related dependencies
PyQt6
PyQt6_sip
pyserial

# To update the requirements.txt file, run the following command:
# pip install pipreqs
# pipreqs path/to/your/project

0 comments on commit 7783fc9

Please sign in to comment.