eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-12 08:40:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Various minor site/documentation changes

Browse source
This commit is contained in:
Ske 2019-08-31 12:32:28 +02:00
parent 9b0b8b4353
commit dbade9b6bc
9 changed files with 39 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -44,6 +44,17 @@ $ docker-compose up -d
* Create and fill in a `pluralkit.conf` file in the same directory as `docker-compose.yml`
* Run the bot: `dotnet run --project PluralKit.Bot`
# Building the docs
The website and documentation are automatically built by GitHub Pages when pushed to the `master` branch. They use [Jekyll 3](https://jekyllrb.com), which requires [Ruby](https://www.ruby-lang.org) and [Bundler](https://bundler.io/).
To build the docs locally, run:
```
$ cd docs/
$ bundle install --path vendor/bundle
$ bundle exec jekyll build
To run an auto-reloading server, substitute the last command with:
$ bundle exec jekyll serve
# License
This project is under the Apache License, Version 2.0. It is available at the following link: https://www.apache.org/licenses/LICENSE-2.0