Update readme with MacOS support.
This commit is contained in:
parent
90b6707cdf
commit
6560cf52b6
4 changed files with 27 additions and 7 deletions
30
README.md
30
README.md
|
@ -1,7 +1,7 @@
|
|||
# BAPSicle
|
||||
### a.k.a. The Next-Gen BAPS server
|
||||
|
||||
!["BAPSicle logo, a pink melting ice lolly."](/dev/logo.png "BAPSicle Logo")
|
||||
!["BAPSicle logo, a pink melting ice lolly."](docs/images/logo.png "BAPSicle Logo")
|
||||
|
||||
Welcome! This is BAPS. More acurately, this is yet another attempt at a BAPS3 server.
|
||||
|
||||
|
@ -16,7 +16,7 @@ Currently there's just a batch script. Simply run ``install.bat`` as administrat
|
|||
This will:
|
||||
* Copy BAPSicle into ``C:\Program Files\BAPSicle``
|
||||
* Install BAPSicle.exe as a Windows Service with NSSM.
|
||||
* If all goes well, open [http://localhost:5000](localhost:5000) for the server UI.
|
||||
* If all goes well, open [http://localhost:5000](localhost:13500) for the server UI.
|
||||
|
||||
### Linux
|
||||
|
||||
|
@ -24,24 +24,40 @@ Installed service for linux is comming soon. Testing is primarily on Ubuntu 20.0
|
|||
|
||||
### MacOS
|
||||
|
||||
Support for MacOS will be the last to come, sorry about that.
|
||||
Currently there's no installer for MacOS, so you'll have to move the ``build/output/BAPSicle.app`` you've built and make it start automatically (if you want).
|
||||
|
||||
Starting and stopping the server, as well as UI links, are available in the System Menu once opening the app.
|
||||
|
||||
!["BAPSicle in the MacOS System Menu"](docs/images/system-menu.png "System Menu")
|
||||
|
||||
## Developing
|
||||
|
||||
### Requirements
|
||||
|
||||
On all platforms:
|
||||
* Python 3.7 (3.8 may also work, 3.9 is unlikely to.)
|
||||
* Git (Obviously)
|
||||
|
||||
On MacOS:
|
||||
* Homebrew (To install command line Platypus)
|
||||
|
||||
### Running
|
||||
To just run the server standaline without installing, run ``python ./launch_standalone.py``.
|
||||
|
||||
### Building
|
||||
## Building
|
||||
|
||||
Currently mostly Windows focused.
|
||||
### Windows
|
||||
|
||||
To build a BAPSicle.exe, run ``build\build-exe.py``. The resulting file will appear in ``build\output``. You can then use the install instructions above to install it, or just run it standalone.
|
||||
To build a ``BAPSicle.exe``, run ``build\build-exe.bat``. The resulting file will appear in ``build\output``. You can then use the install instructions above to install it, or just run it standalone.
|
||||
|
||||
### Linux
|
||||
|
||||
Coming soon...
|
||||
|
||||
### MacOS
|
||||
|
||||
To build a ``BAPSicle.app``, run ``build/build-macos.sh``. The resulting file will appear in ``build/output``.
|
||||
|
||||
### Other bits
|
||||
|
||||
Provided is a VScode debug config to let you debug live, as well as ``dev\install-githook.bat`` that will help git to clean your code up as you're committing!
|
||||
Provided is a VScode debug config to let you debug live, as well as ``dev\install-githook.{bat,sh}`` that will help git to clean your code up as you're committing!
|
||||
|
|
4
dev/install-githook.sh
Normal file
4
dev/install-githook.sh
Normal file
|
@ -0,0 +1,4 @@
|
|||
#!/bin/bash
|
||||
cd "$(dirname "$0")"
|
||||
|
||||
cp "./pre-commit" "../.git/hooks/"
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
BIN
docs/images/system-menu.png
Normal file
BIN
docs/images/system-menu.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 83 KiB |
Loading…
Reference in a new issue