Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

SoftCOM by Integrated Software Technologies Inc.

About The Project

SoftCOM is a free software for accessing the serial port. Please reed the license agreement for more details.

(back to top)

Supported Operating-Systems

• Microsoft Windows v10 64-bit
• MacOS Monterey v12.2.1
• Ubuntu 20.04
• RedHat 8.5

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Python
• prompt_toolkit
• pyperclip
• argparse
• pre-commit
• pylintpylint
• serial

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/mathieeo/softcom.git
   

2. Install virtual environment

   pip install virtualenv
   

3. Run virtual

   virtualenv venv && source venv/bin/activate
   

4. Install requirements

   pip install -r requirements.txt
   

(back to top)

Usage

From the terminal (Console) cd to the project directory from there execute the following command:

python3.10 softcom.py

Application arguments:

Argument	pram	Description
--simulator	-s	Run in simulator mode
--config	-c	re-configure serial port

in-app Options:

Option	Key	Description
Quit	Control+Q	Quit the application
Clear Log	Control+X	Clears the output log
Pauses Log	Control+P	Pause the output logging
Export to File	Control+S	Export the output log to a file
Start/Stop Capture	Control+W	Start the capture mode. Save portion of output log.
Copy to Clipboard	Control+C	Copy the entire log to the clipboard
Highlight Pattern	Control+S	Search and find for a specific string
Find and Stop	Control+G	Search and find for a specific string and stop if found.
Show License	Control+L	Show the license for this application.
Help	Control+H	Used to show help string.
Debug	Shift+Tab	Used for debuting.

(back to top)

Roadmap

• Add Changelog
• Add back to top links
• Add Additional Templates w/ Examples
• Add "components" document to easily copy & paste sections of the readme

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU GPLv3 License. See LICENSE for more information.

(back to top)

Contact

Matthew - eMail

Project Link: SoftCOM

(back to top)