diff --git a/README.md b/README.md index 6a90e62..b998ec0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# OSC2AHK +## OSC2AHK This is a DLL extension for [AutoHotkey](https://www.autohotkey.com/) that enables support for OSC (Open Sound Control). @@ -6,23 +6,26 @@ This is a DLL extension for [AutoHotkey](https://www.autohotkey.com/) that enabl While most functions should already work as intended, there may still be some bugs. If you encounter some possibly wrong behaviour, please let us know! * OSC address wildcards are supported now but probably need some testing +## Table of contents + - [OSC2AHK](#osc2ahk) - - [Work in progress](#work-in-progress) - - [Installation](#installation) - - [Usage](#usage) - - [General concept](#general-concept) - - [Receive functions](#receive-functions) - - [Load DLL](#load-dll) - - [Open network port](#open-network-port) - - [Close network port](#close-network-port) - - [Add listener](#add-listener) - - [Remove listener](#remove-listener) - - [Get string data](#get-string-data) - - [Send functions](#send-functions) - - [Send integer message](#send-integer-message) - - [Send float message](#send-float-message) - - [Send string message](#send-string-message) - - [Credits](#credits) +- [Work in progress](#work-in-progress) +- [Table of contents](#table-of-contents) +- [Installation](#installation) +- [Usage](#usage) + - [General concept](#general-concept) + - [Receive functions](#receive-functions) + - [Load DLL](#load-dll) + - [Open network port](#open-network-port) + - [Close network port](#close-network-port) + - [Add listener](#add-listener) + - [Remove listener](#remove-listener) + - [Get string data](#get-string-data) + - [Send functions](#send-functions) + - [Send integer message](#send-integer-message) + - [Send float message](#send-float-message) + - [Send string message](#send-string-message) +- [Credits](#credits) ## Installation Just download the latest version of OSC2AHK.dll from the [releases page](https://files.eleton-audio.de/gitea/Ludwig/OSC2AHK/releases) and place it in the same directory as your AutoHotkey scripts. Maybe you also want to check out the provided [usage examples](https://files.eleton-audio.de/gitea/Ludwig/OSC2AHK/src/branch/master/examples).