Skip to content

Commit

Permalink
README: Installation Instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexKnauth committed Nov 13, 2024
1 parent 0e6855d commit 22e6dc3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@ A prototype Desktop version of LiveSplit One, using the Druid framework and the

The Web Version is available at [one.livesplit.org](https://one.livesplit.org/).

## Installation Instructions

Download the latest release for your operating system and archictecture here:
https://github.com/AlexKnauth/livesplit-one-druid/releases/latest

When you run LiveSplit One Druid,
it needs to have permission to read memory of other processes.
- On Mac, that might require running it under `sudo`.
- On Linux, give it permission with one of:
- setting the capabilities to include `CAP_SYS_PTRACE`, which can be done with
`sudo setcap CAP_SYS_PTRACE=+eip LiveSplitOne` or some variation of that
- setting `/proc/sys/kernel/yama/ptrace_scope` to 0, which can be done with
`echo "0"|sudo tee /proc/sys/kernel/yama/ptrace_scope`
- running it under `sudo`
- On Windows, it should just work. Windows allows memory reading by default.

## Build Instructions

In order to build LiveSplit One you need the [Rust
Expand Down

0 comments on commit 22e6dc3

Please sign in to comment.