Skip to content
This repository was archived by the owner on Nov 18, 2021. It is now read-only.

Commit 32c3c12

Browse files
authored
Update README.md
1 parent 0c3bdbb commit 32c3c12

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,14 @@ A tModLoader Terraria mod to add Touch Bar functionality to Terraria for support
1010
## Usage
1111
Simply launch Terraria and the TerraTouchBar application. The mod and the application will communicate automatically.
1212

13+
## Notes
14+
There are currently a few **major** issues with the project, the main one being that there are *vast* memory leaks when receiving updates to the inventory. I've taken the liberty of adding a `Preview` button to the `ContentView`, so that "mockup" updates can be sent. This allows anyone to debug these memory leaks, regardless of whether they own Terraria.
15+
16+
To create the memory leaks (for debugging):
17+
1) Launch the Xcode project
18+
2) Build and run
19+
3) Click the `Preview` button
20+
4) Leave the application for a few minutes.
21+
1322
## Mockup
1423
![Mockup](https://github.com/jacobcxdev/TerraTouchBar/blob/master/Mockup.png?raw=true)

0 commit comments

Comments
 (0)