-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(readme): extend the readme with more info
- Loading branch information
Showing
1 changed file
with
40 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,44 @@ | ||
# Mechvibes Lite | ||
Under construction. | ||
Mechvibes Lite is a lightweight alternative to Mechvibes. It boasts full compatibility with the original version. | ||
|
||
# Documentation | ||
Please visit <https://mechvibes-lite.pages.dev/> for documentation. | ||
|
||
# Installation | ||
Please read the [relevant documentation](https://mechvibes-lite.pages.dev/#installation). | ||
|
||
# Usage | ||
Please read the [relevant documentation](https://mechvibes-lite.pages.dev/#usage). | ||
|
||
# Command-line Arguments | ||
```shell | ||
usage: mvibes [-h] [-L LOG_LEVEL] [--no-config] [--with-config WITH_CONFIG] | ||
[--theme-dir THEME_DIR] [--theme-folder-name THEME_FOLDER_NAME] | ||
[--wskey-host WSKEY_HOST] [--wskey-port WSKEY_PORT] [--no-wskey] | ||
{daemon,wskey} ... | ||
|
||
Mechvibes Lite is an alternative to Mechvibes (it plays sounds when you press | ||
keys). | ||
|
||
positional arguments: | ||
{daemon,wskey} | ||
daemon Run the keyboard input player as a daemon | ||
wskey WebSocket server for sending keyboard input | ||
|
||
options: | ||
-h, --help show this help message and exit | ||
-L LOG_LEVEL, --log-level LOG_LEVEL | ||
Set log level. Options: DEBUG, INFO (default), | ||
CRITICAL, ERROR | ||
--no-config Don't read config file from standard locations. Will | ||
error if you don't provide required configuration as | ||
flags instead. | ||
--with-config WITH_CONFIG | ||
Load this configuration instead of the one at the | ||
standard location. Can be - for stdin. | ||
--theme-dir THEME_DIR | ||
--theme-folder-name THEME_FOLDER_NAME | ||
--wskey-host WSKEY_HOST | ||
--wskey-port WSKEY_PORT | ||
--no-wskey | ||
``` |