Skip to content

Commit 9ae9348

Browse files
authored
Update README.md
1 parent f465a0b commit 9ae9348

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ If using the library, please quote: __Nika, J., Déguernel, K., Chemla, A., Vinc
3838
### Running the Dicy2 Python Library
3939
In the root of this repository, there are two examples illustrating two different usages of the Dicy2 Python Library:
4040
* `generator_tutorial.py`: A minimal example on how to quickly generate content using the `Generator` class. Edit the file to run the different queries or to write your own queries
41-
* `dicy2_server.py`: The server that is used by the [Dicy2 Max Library](https://github.com/DYCI2/Dicy2/releases). This illustrates communication over OSC, see the header of the file for more information. Run with `./dicy2_server.py`
41+
* `dicy2_server.py`: The server that is used by the [Dicy2 Max Library](https://github.com/DYCI2/Dicy2/releases).
42+
This illustrates communication over OSC, see the header of the file for more information. Run with `./dicy2_server.py`.
43+
* For an example of communication with a Dicy2 server, see `docs/Example_of_OSC_messages_Dicy2_server.md`.
4244

4345
------
4446

@@ -48,9 +50,11 @@ In the root of this repository, there are two examples illustrating two differen
4850
The examples outlined under [Running the Dicy2 Python Library](#Running-the-Dicy2-Python-Library) are excellent starting points, but there are a couple of other possible classes to start from if you want to integrate the DYCI2 Python Library in your own project:
4951
* The `Generator` class (`dicy2/generator.py`) is a good starting point for generating content in an offline setting without managing time
5052
* The `GenerationScheduler` class (`dicy2/generation_scheduler.py`) is a good starting point for generating content with time management in real-time
51-
* The `Agent` (`dicy2/agent.py`) and `DICY2Server` (`dicy2.py`) are good starting points for managing one or several `GenerationSchedulers` over the OSC protocol
53+
* The `Agent` (`dicy2/agent.py`) and `DICY2Server` (`dicy2.py`) are good starting points for managing one or several `GenerationSchedulers` over the OSC protocol.
5254

53-
For a specification on the OSC protocol used in the Dicy2 Python Library, see `docs/osc_protocol.md`. Its usage is also thoroughly documentented in the header of the `dyci2_server.py` file.
55+
### Communicating with Dicy2 server.
56+
* For an example of communication with a Dicy2 server, see `docs/Example_of_OSC_messages_Dicy2_server.md`.
57+
* For a specification on the OSC protocol used in the Dicy2 Python Library, see `docs/osc_protocol.md`. Its usage is also thoroughly documented in the header of the `dyci2_server.py` file.
5458

5559

5660
### Building the Dicy2 Server Application

0 commit comments

Comments
 (0)