Updated information

ljoonal 2019-02-07 00:48:07 +02:00
parent 58b858cbca
commit f368ad644d
Signed by: ljoonal
GPG key ID: C74D75DE349ACD93
3 changed files with 16 additions and 12 deletions

@ -4,6 +4,8 @@ Thank you for being interested in this project!
There are a few basic things that you'll need to confirm before code gets to the master branch:
1. The code passes ESlint.
1. The code passes linting and tests.
2. The code is understandable.
3. The code works.
3. The code works.
If you want an account on my git instance, just send me a message. Please do note though that I don't take kindly to people using up a lot of my resources without my permission, so discuss it with me if you want to also host your projects in my git instance.

@ -1,17 +1,19 @@
# Installation
Please note that these instructions use [Yarn](https://yarnpkg.com/). You should be able to do quite the same with npm though, but the lockfile is in yarn format, so I'm not officially supporting npm.
## Windows
1. Install [ffmpeg](https://ffmpeg.org/) and add it to your path.
2. Open cmd as an administrator, and install [windows build tools](https://github.com/felixrieseberg/windows-build-tools) that node-gyp needs ( `npm install -g windows-build-tools` )
3. Install [node-gyp](https://github.com/nodejs/node-gyp) ( `npm install -g node-gyp` )
4. Clone the repository.
5. Then open a normal terminal window in the cloned reposity and run `npm i` to install things
6. And then run `npm run config` to generate a configuration file.
2. Open cmd as an administrator, and install [windows build tools](https://github.com/felixrieseberg/windows-build-tools) that node-gyp needs ( `yarn global windows-build-tools` )
3. Install [node-gyp](https://github.com/nodejs/node-gyp) ( `yarn global node-gyp` )
4. Clone the repository or download a release.
5. Then open a normal terminal window in the cloned reposity and run `yarn` to install things
6. And then run `yarn run config` to generate a configuration file.
### Troubleshooting
If you have multiple python installations: `npm config set python C:/path/to/executable/python2.7`
If you have multiple python installations: `yarn config set python C:/path/to/executable/python2.7`
If it still fails at step 3 or 4, open cmd as admin and type `SET VCTargetsPath=C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140`, replacing any wrong paths with the real path.
For me it was trying to use V120 when it was installed at V140. Then continue from step 3 again.
@ -19,7 +21,7 @@ For me it was trying to use V120 when it was installed at V140. Then continue fr
## Other platforms
1. Install [ffmpeg](https://ffmpeg.org/) and add it to your path.
2. Clone the repository.
2. Clone the repository or download a release.
3. Install [node-gyp](https://github.com/nodejs/node-gyp).
4. Run `npm i`
5. Run `npm run config`
4. Run `yarn`
5. Run `yarn run config`

@ -20,7 +20,7 @@ The guild owner has always permissions to use every command.
### Security
It's good practice to specify the `ids` in the group as well. It can only be 1 group id, in a format of `id:["groupidhere"]`. That way you can be sure that only the groups you mean get access to it. Since if `ids` is left undefined, it'll use the group's name to find the id.
It's good practice to specify the `ids` in the group as well. Format is `id:["groupidhere"]`. That way you can be sure that only the groups you mean get access to it. Since if `ids` is left undefined, it'll use the group's name to find the id.
## Limits