liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify install instructions in the README

Browse Source
This commit is contained in:
Ske 2019-07-10 16:24:33 +02:00
parent 8afb2f892b
commit 8940226385
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -25,12 +25,23 @@ Running PluralKit is pretty easy with Docker. The repository contains a `docker-
* Clone this repository: `git clone https://github.com/xSke/PluralKit` * Clone this repository: `git clone https://github.com/xSke/PluralKit`
* Create a `pluralkit.conf` file in the same directory as `docker-compose.yml` containing at least a `PluralKit.Bot.Token` field * Create a `pluralkit.conf` file in the same directory as `docker-compose.yml` containing at least a `PluralKit.Bot.Token` field
* (`PluralKit.Database` is overridden in `docker-compose.yml` to point to the Postgres container)
* Build the bot: `docker-compose build` * Build the bot: `docker-compose build`
* Run the bot: `docker-compose up` * Run the bot: `docker-compose up`
In other words:
```
$ git clone https://github.com/xSke/PluralKit
$ cd PluralKit
$ cp pluralkit.conf.example pluralkit.conf
$ nano pluralkit.conf # (or vim, or whatever)
$ docker-compose up -d
```
## Manually ## Manually
* Install the .NET Core 2.2 SDK (see https://dotnet.microsoft.com/download) * Install the .NET Core 2.2 SDK (see https://dotnet.microsoft.com/download)
* Clone this repository: `git clone https://github.com/xSke/PluralKit` * Clone this repository: `git clone https://github.com/xSke/PluralKit`
* Create and fill in a `pluralkit.conf` file in the same directory as `docker-compose.yml`
* Run the bot: `dotnet run --project PluralKit.Bot` * Run the bot: `dotnet run --project PluralKit.Bot`