Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project setup instructions #1

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update ReadMe with instructions on project setup
  • Loading branch information
Malika- committed Mar 23, 2024
commit 41ba43e9deff9cb55c1941c9fe1716834b479ce0
28 changes: 28 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -47,3 +47,31 @@ Where:
* **Frame data** - n byte, data of the frame, can be empty. Sometimes first 2 bytes of data are used as a subcommand. Max size 246
* **Checksum** - 1 byte, the least significant byte of the sum of all bytes of the frame except separator bytes, CRC, and checksum itself.
* **CRC** - 2 bytes, CRC 16 of all bytes of the frame except separator bytes and CRC itself (Modbus CRC algorithm used). CRC is available only if the frame flags byte indicates it.

Setup / usage
--------------------

Prerequisites
-----------
* Windows (no support for compilation on other OSes as of now)
* CMake https://cmake.org/download/
* Visual Studio Code or another way to compile C++

Running the application
-----------

1. Use CMake to generate the necessary files
```
mkdir build && cd build
cmake ..
cd ..
```

2. Build
```
cmake --build build --config Debug --target all
```

3. Run
?
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Todo add instructions here on how to run it