Skip to content

Commit ca2b9d6

Browse files
authored
Update README.md
1 parent 829af98 commit ca2b9d6

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,6 @@ a service from Python.
5151
The idea is to create a separate thread inside Unity that will send a request to python, receive a reply and log the reply
5252
to the console.
5353

54-
Most of the code are just copies from the official ZeroMQ tutorial. I try to make this as simple to grasp as possible,
55-
so I only log the message to the console and nothing fancy.
56-
5754
## Getting Started
5855

5956
1. Clone this repository using `git clone https://github.com/off99555/Unity3D-Python-Communication.git` command.
@@ -98,6 +95,14 @@ Based on [this issue](https://github.com/zeromq/netmq/issues/631), the NetMQ imp
9895

9996
The problem is that when you restart the server, the server won't reconnect to the old client anymore. You have to restart the client also.
10097

98+
## Disclaimer
99+
100+
This repository is designed to be a **minimal learning resource** for getting started. It's not a fully working high-level package.
101+
After you understand the example, my job is done.
102+
103+
Most of the code are just copies from the official ZeroMQ tutorial. I try to make this as simple to grasp as possible,
104+
so I only log the message to the console and nothing fancy. This is to minimize the unnecessary learning curve.
105+
101106
## TODO
102107

103108
* [ ] Add a complicated example of how to use it for real

0 commit comments

Comments
 (0)