updated readme
This commit is contained in:
parent
18c60b67db
commit
dadbf776dc
|
@ -1,30 +1,39 @@
|
|||
# ida-bot
|
||||
## a chatbot for owncast servers built with alien technology
|
||||
|
||||
## Usage
|
||||
### **NOTE, THIS IS ALPHA QUALITY SOFTWARE WITH NO API DOCUMENTATION**
|
||||
### **ENTER AT YOUR OWN RISK**
|
||||
|
||||
### Usage
|
||||
|
||||
`$ ./ida-bot --help` to print command usage
|
||||
|
||||
`$ ./ida-bot -c your.config -p 8080` to run the bot with the specified config and on port 8080
|
||||
|
||||
the bot loads all lisp code from `./commands`, `./handlers`, and `./services` when ran, so if you are planning on creating a custom extension please place your code in one of those folders.
|
||||
|
||||
the bot will load all lisp code in the `./commands` folder if it exists. while this is pretty unsafe it allows you (developers) to quickly create commands using the full power of lisp!
|
||||
the bot comes with a few pre-built commands/handlers/services (check the appropriate folders in the repo). feel free to add your own, and contribute some back if you feel like it :)
|
||||
|
||||
|
||||
the bot comes with a few pre-built commands (check commands folder). feel free to add your own, and contribute some back to the repo if you feel like it :)
|
||||
### Installation
|
||||
|
||||
right now only chat-initiated commands are supported, but thats planning on changing soon.
|
||||
download a binary release from releases or see [Building](#building)
|
||||
|
||||
## Installation
|
||||
### Building
|
||||
|
||||
download a binary release from releases
|
||||
1. install [roswell](https://github.com/roswell/roswell)
|
||||
2. `$ ros install sbcl-bin/2.3.2 && ros use sbcl-bin/2.3.2`
|
||||
3. `$ git clone https://github.com/compufox/simple-config ~/common-lisp/simple-config`
|
||||
4. `$ git clone https://github.com/compufox/ida-bot ~/common-lisp/ida-bot`
|
||||
5. `$ cd ~/common-lisp/ida-bot && make all extensions`
|
||||
|
||||
if all goes well, you should have a binary with all pre-built extensions in `~/common-lisp/ida-bot/bin`
|
||||
|
||||
## Author
|
||||
### Author
|
||||
|
||||
* a. fox
|
||||
- a. fox
|
||||
|
||||
## License
|
||||
### License
|
||||
|
||||
BSD 3-Clause
|
||||
|
||||
|
|
Loading…
Reference in New Issue