Skip to content

Commit 2b53713

Browse files
committed
README: Improve the example instructions to also work on Windows
1 parent aeb4a32 commit 2b53713

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ for UART/RS232 or UDP/IP.
1111

1212
## Install
1313

14-
Packages are coming soon...
14+
pip install compost_rpc
1515

1616
## Documentation
1717

@@ -77,11 +77,25 @@ Simplified functionality diagram:
7777

7878
You just need Python and a C compiler like GCC to run our single PC example.
7979

80+
Clone the repository and enter the directory with the example:
81+
8082
git clone https://github.com/STMicroelectronics/compost-rpc.git
8183
cd compost-rpc/examples/pc_to_pc
84+
85+
Generate C code from the protocol definition:
86+
8287
python protocol_def.py
88+
89+
Compile the server:
90+
91+
On Linux or macOS:
92+
8393
gcc -o server main.c compost.c
8494

95+
On Windows:
96+
97+
gcc -o server main.c compost.c -lws2_32
98+
8599
In one terminal run the C server:
86100

87101
./server

0 commit comments

Comments
 (0)