Skip to content

Commit

Permalink
Updated appcast/release xml location
Browse files Browse the repository at this point in the history
  • Loading branch information
ruittenb committed Sep 4, 2024
1 parent afa794b commit 61c1fc4
Show file tree
Hide file tree
Showing 2 changed files with 124 additions and 1 deletion.
1 change: 0 additions & 1 deletion README.md

This file was deleted.

96 changes: 96 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
![Spaceman Example](Images/Header.png)

## About

Spaceman is an application for macOS that allows you to view your Spaces / Virtual Desktops in the menu bar. Spaceman allows you to see which space you are currently on (or spaces if you are using multiple displays) relative to the other spaces you have. Naming these spaces is also an option in order to organise separate spaces for your workflow.

Also, the menu enables switching between spaces.

**Spaceman requires macOS 11 Big Sur or greater.**

## Install

### GitHub

Go to the [releases](https://github.com/ruittenb/Spaceman/releases) tab and download **Spaceman.dmg** from the latest release.

## Usage

<a href="url"><img src="Images/Spaceman_Example.png" height="auto" width="auto" style="border-radius:10px"></a>

The above image shows the possible icons that you will see depending on the style you choose.

There are five styles to choose from, from top to bottom:
- Rectangles
- Numbers
- Rectangles with Numbers
- Rectangles with Desktop Numbers
- Named Spaces

The meaning of the icons from left to right are:

- Active Space
- Inactive Space
- Inactive Fullscreen App
- Gap (The gap denotes that the spaces that follow are on a different display)
- Inactive Space
- Active Fullscreen App

## Preferences

<a href="url"><img src="Images/Preferences-3a.png" height="auto" width="auto" style="border-radius:10px"></a>

The style and the name of a space can be changed in preferences (shown above). A space is named by selecting the space from the dropdown, typing a name up to 4 characters and clicking the 'Update name' button.

If the icon fails to update, you can choose to force a refresh of the icon using a custom keyboard shortcut or allow Spaceman to refresh them automatically every 5 seconds by enabling 'Refresh spaces in background'. See [#2](https://github.com/Jaysce/Spaceman/issues/2).

### Switching Spaces

The menu shows a list of space names.

<a href="url"><img src="Images/Menu.png" height="auto" width="auto" style="border-radius:10px"></a>

Choosing one will cause Spaceman to attempt to switch to that space.
This is done by sending a keyboard shortcut to Mission Control using `osascript`.
Note that only the first ten spaces will have shortcut keys assigned.

For this to work successfully, the following things need to be configured:

- Spaceman needs authorization for Accessibility:

<a href="url"><img src="Images/Accessibility-1.png" height="auto" width="auto" style="border-radius:10px"></a>
<a href="url"><img src="Images/Accessibility-2.png" height="auto" width="auto" style="border-radius:10px"></a>

- Shortcut keys need to have been defined for Mission Control:

<a href="url"><img src="Images/Shortcuts.png" height="auto" width="auto" style="border-radius:10px"></a>

- Spaceman needs to know which shortcuts to send:

<a href="url"><img src="Images/Preferences-3b.png" height="auto" width="auto" style="border-radius:10px"></a>

## Remote Refresh

The list of spaces can also be refreshed using Applescript:

```sh
$ osascript -e 'tell application "Spaceman" to refresh'
```

## Attributions

- This project is based on [WhichSpace](https://github.com/gechr/WhichSpace)
- This project uses [Sparkle](https://sparkle-project.org) for update delivery
- This project makes use of [LaunchAtLogin](https://github.com/sindresorhus/LaunchAtLogin)
- This project makes use of [KeyboardShortcuts](https://github.com/sindresorhus/KeyboardShortcuts)
- Authors:
- [Sasindu Jayasinghe](https://github.com/Jaysce/Spaceman)
- [René Uittenbogaard](https://github.com/ruittenb/Spaceman)
- Contributions by:
- [Dmitry Poznyak](https://github.com/triangular-sneaky/Spaceman)
- [Grzegorz Milka](https://github.com/gregorias)
- [Michael Lehenauer](https://github.com/mike-jl/Spaceman)
- [Logan Savage](https://github.com/lxsavage/Spaceman)
- [Yakir Lugasy](https://github.com/yakirlog/Spaceman)
- [aaplmath](https://github.com/aaplmath)

28 changes: 28 additions & 0 deletions appcast.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" standalone="yes"?>
<rss xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" version="2.0">
<channel>
<title>Spaceman</title>
<item>
<title>1.5.5-R: Better support for restarting numbering by desktop</title>
<description>
<![CDATA[
<ul>
<li>1.5.5-R: Support for restarting numbering in menu and numbers-only rendering</li>
<li>1.5.4-R: Minor refactoring</li>
<li>1.5.3-R: Tweaked menu icon opacity</li>
</ul>
]]>
</description>
<pubDate>Wed, 04 Sep 2024 00:39:23 +0200</pubDate>
<sparkle:minimumSystemVersion>11.0</sparkle:minimumSystemVersion>
<enclosure
url="https://github.com/ruittenb/Spaceman/releases/download/v1.5.5-R/Spaceman-1.5.5-R.dmg"
sparkle:version="1.5.5-R"
sparkle:shortVersionString="1.5.5-R"
length="2433595"
type="application/octet-stream"
ERROR:
/>
</item>
</channel>
</rss>

0 comments on commit 61c1fc4

Please sign in to comment.