Skip to content

Commit

Permalink
Update install instructions, front page, desc
Browse files Browse the repository at this point in the history
  • Loading branch information
pilgrimtabby committed Jun 1, 2024
1 parent ec2ead6 commit 2ee2417
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
8 changes: 5 additions & 3 deletions 05-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ nav_order: 5

# Installation

You can download the latest build and the source code [here](https://github.com/pilgrimtabby/pilgrim-autosplitter/releases/).
You can download the latest build or the source code [here](https://github.com/pilgrimtabby/pilgrim-autosplitter/releases/).

{: .important }
The source code should work on Windows and MacOS, but the built app is currently only available on MacOS. See [this page](https://github.com/pilgrimtabby/pilgrim-autosplitter/?tab=readme-ov-file#installation) for more details.
The source code is compatible with Windows and MacOS. However, the built app is currently only available for silicon-based Macs. See [this page](https://github.com/pilgrimtabby/pilgrim-autosplitter/?tab=readme-ov-file#installation) for more details.

For a step-by-step guide to installation on Windows and MacOS, including tips for installing and running Python, see [this page](https://github.com/pilgrimtabby/pilgrim-autosplitter/?tab=readme-ov-file#installation).
Even if you can't use the built app, running the source code is straightforward if you follow this [step-by-step guide](https://github.com/pilgrimtabby/pilgrim-autosplitter/?tab=readme-ov-file#installation).

If you have any questions or concerns, please feel free to [open an issue](https://github.com/pilgrimtabby/pilgrim-autosplitter/issues) on Pilgrim Autosplitter's repository page or email me directly at [email protected].
6 changes: 3 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
title: Pilgrim Autosplitter
email: [email protected]
description: >- # this means to ignore newlines until "baseurl:"
Finally, an image-based autosplitter for MacOS speedrunners!
Finally, an image-based autosplitter for console, Windows PC, and MacOS!
Set up global hotkeys, customize split images, choose from
different themes, and never touch a keyboard while speedrunning
again — even on MacOS.
different themes, and never touch a keyboard during a speedrun
again — even when streaming from or playing on MacOS.
domain: pilgrimtabby.github.io
baseurl: /pilgrim-autosplitter/ # the subpath of your site, e.g. /blog
url: https://pilgrimtabby.github.io # the base hostname & protocol for your site, e.g. http://example.com
Expand Down
10 changes: 7 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,18 @@ title: Overview
<link rel="stylesheet" href="css/main.css">
</header>

# Pilgrim Autosplitter for MacOS
# Pilgrim Autosplitter for MacOS: User Manual

Finally, an image-based speedrun autosplitter for MacOS!
Finally, an image-based speedrun autosplitter compatible with MacOS!

<figure>
<img src="images/demo.gif" class="massive-image" alt="A simple demonstration">
</figure>

Pilgrim Autosplitter was designed for MacOS to fill the gap left by other image-based speedrun autosplitters, which generally only support Windows.
Pilgrim Autosplitter was designed to fill the gap left by other image-based speedrun autosplitters, which are generally incompatible with MacOS.

Bring your best speedgame whether you're running on console, MacOS, or PC.

Compatible with MacOS and Windows.

[Get the latest release](https://github.com/pilgrimtabby/pilgrim-autosplitter/releases), or [check out the source code](https://github.com/pilgrimtabby/pilgrim-autosplitter/).

0 comments on commit 2ee2417

Please sign in to comment.