update readme
This commit is contained in:
parent
9a800bb839
commit
ebdcbb8b12
1 changed files with 22 additions and 0 deletions
22
README.md
22
README.md
|
@ -2,3 +2,25 @@
|
||||||
|
|
||||||
# Jarvis Assistant for Marvel Rivals
|
# Jarvis Assistant for Marvel Rivals
|
||||||
|
|
||||||
|
A simple piece of software i cooked up in a few hours because it would be funny
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
```
|
||||||
|
uv sync # sync dependencies (setup only)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
uv run main.py
|
||||||
|
```
|
||||||
|
|
||||||
|
Press the hotkey (default is Home) and then talk to jarvis
|
||||||
|
|
||||||
|
### Supported Commands
|
||||||
|
|
||||||
|
- say something in team/match chat
|
||||||
|
- maximum pulse
|
||||||
|
|
||||||
|
Checkout the code to see specific keywords/phrases as all NLP is regex/string based, not generative AI
|
Loading…
Add table
Add a link
Reference in a new issue