Skip to content

Commit 2aed339

Browse files
authored
Update README.md
1 parent d54074b commit 2aed339

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,23 +40,29 @@ In the root of this repository, there are two examples illustrating two differen
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
4141
* `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`
4242

43+
------
44+
4345
### Going Further
46+
47+
## Some entry points
4448
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:
4549
* The `Generator` class (`dicy2/generator.py`) is a good starting point for generating content in an offline setting without managing time
4650
* The `GenerationScheduler` class (`dicy2/generation_scheduler.py`) is a good starting point for generating content with time management in real-time
4751
* The `Agent` (`dicy2/agent.py`) and `DICY2Server` (`dicy2.py`) are good starting points for managing one or several `GenerationSchedulers` over the OSC protocol
4852

4953
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.
5054

51-
------
5255

5356
## Building the Dicy2 Server Application
5457
While this use case is unlikely to be relevant for most users, it is possible to build a standalone application of the `dicy2_server.py` from the Python code using [PyInstaller](https://pyinstaller.org/en/stable/). A pre-built application is already distributed in the release of the [Dicy2 Max Library](https://github.com/DYCI2/Dicy2/releases).
5558

56-
See the head of the `Makefile` for information on building
59+
See the head of the `Makefile` for information on building.
60+
61+
------
5762

63+
### More
5864

59-
## Troubleshooting
65+
## Contact us
6066
Please write to `jerome.nika@ircam.fr` for any question, or to share with us your projects using Dicy2!
6167

6268
## License

0 commit comments

Comments
 (0)