Enhanced project documentation and release automation
- Improved README.md formatting and structure - Added installation instructions for pre-built executables - Included platform-specific examples for Windows, Linux, and macOS - Set up Gitea workflow for automated builds on new releases - Added platform-specific PyInstaller spec files for all supported platforms - Updated repository links to point to repo.anhonesthost.net These changes make the project more accessible to new users and streamline the release process with automatic executable generation for all platforms.
This commit is contained in:
82
README.md
82
README.md
@@ -32,21 +32,25 @@ A versatile MacroPad server application that lets you create, manage, and execut
|
||||
|
||||
## Installation
|
||||
|
||||
### Method 1: From Source
|
||||
|
||||
1. Clone or download this repository
|
||||
2. Install the required dependencies:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Alternative Installation Method
|
||||
#### Windows only
|
||||
### Method 2: Pre-built Executables
|
||||
|
||||
1. Create a Folder you wish to run MacroPad from
|
||||
2. Download ```macropad.exe``` from the ```dist``` folder
|
||||
3. Accept the security notices, and run the application
|
||||
1. Go to the [Releases](https://repo.anhonesthost.net/MacroPad/MP-Server/releases) page
|
||||
2. Download the appropriate version for your operating system:
|
||||
- Windows: `macropad.exe`
|
||||
- Linux: `macropad`
|
||||
- macOS: `macropad.app`
|
||||
3. Run the downloaded file
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The executable is unsigned and may trigger security warnings. You may need to click "More info" and "Run anyway" in Windows SmartScreen or add an exception in your antivirus software.
|
||||
> The executables are unsigned and may trigger security warnings. You may need to click "More info" and "Run anyway" in Windows SmartScreen, adjust permissions on Linux (`chmod +x macropad`), or override Gatekeeper on macOS.
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -94,11 +98,67 @@ When minimized to the system tray:
|
||||
### Windows Examples
|
||||
|
||||
#### Steam Applications
|
||||
```"C:\Program Files (x86)\Steam\steam.exe" steam://rungameid/2767030```
|
||||
```
|
||||
"C:\Program Files (x86)\Steam\steam.exe" steam://rungameid/2767030
|
||||
```
|
||||
|
||||
#### Chrome to a website
|
||||
```
|
||||
"C:\Program Files\Google\Chrome\Application\chrome.exe" http://twitch.tv/shadowdao
|
||||
```
|
||||
|
||||
```"C:\Program Files\Google\Chrome\Application\chrome.exe" http://twitch.tv/shadowdao```
|
||||
#### Run Notepad
|
||||
```
|
||||
notepad.exe
|
||||
```
|
||||
|
||||
#### Open File Explorer to a specific location
|
||||
```
|
||||
explorer.exe "C:\Users\YourUsername\Documents"
|
||||
```
|
||||
|
||||
### Linux Examples
|
||||
|
||||
#### Opening Firefox
|
||||
```
|
||||
firefox https://example.com
|
||||
```
|
||||
|
||||
#### Opening Steam
|
||||
```
|
||||
steam steam://rungameid/2767030
|
||||
```
|
||||
|
||||
#### Launch Terminal
|
||||
```
|
||||
gnome-terminal
|
||||
```
|
||||
|
||||
#### Open File Manager
|
||||
```
|
||||
nautilus ~/Documents
|
||||
```
|
||||
|
||||
### macOS Examples
|
||||
|
||||
#### Opening Safari
|
||||
```
|
||||
open -a Safari https://example.com
|
||||
```
|
||||
|
||||
#### Opening Terminal
|
||||
```
|
||||
open -a Terminal
|
||||
```
|
||||
|
||||
#### Open Finder to a specific location
|
||||
```
|
||||
open ~/Documents
|
||||
```
|
||||
|
||||
#### Launch Applications
|
||||
```
|
||||
open -a "Visual Studio Code"
|
||||
```
|
||||
|
||||
#### Special Thanks to CatArgent_ on Twitch for proof reading my stuff and providing valuable feedback.
|
||||
Reference in New Issue
Block a user