ulysia/szurubooru
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added links to README

Browse source
This commit is contained in:
Marcin Kurczewski 2014-10-18 20:05:45 +02:00
parent 83394792c6
commit 45b27c22ec
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -13,11 +13,11 @@ scraping or scrubbing. It is pronounced *"shoorubooru"* [ˌʃuruˈburu].
## Licensing ## Licensing
Please see the file named `LICENSE`. Please see the file named [`LICENSE`](https://github.com/rr-/szurubooru/blob/master/LICENSE).
## Installation ## Installation
Please see the file named `INSTALL.md`. Please see the file named [`INSTALL.md`](https://github.com/rr-/szurubooru/blob/master/INSTALL.md).
## Bugs and feature requests ## Bugs and feature requests
@ -40,14 +40,14 @@ Here are some guidelines on how to contribute:
- Respect coding standards - be consistent with existing code base. - Respect coding standards - be consistent with existing code base.
- Watch your whitespace - don't leave any characters at the end of the lines. - Watch your whitespace - don't leave any characters at the end of the lines.
- Always run tests before pushing. - Always run tests before pushing.
- Before starting, see `INSTALL.md`. - Before starting, see [`INSTALL.md`](https://github.com/rr-/szurubooru/blob/master/INSTALL.md).
- Use `grunt` to do automatic tasks like minifying `JS` files or running - Use `grunt` to do automatic tasks like minifying Javascript files or running
tests. Run `grunt --help` to see full list of available tasks. tests. Run `grunt --help` to see full list of available tasks.
## API ## API
Szurubooru from version 0.9+ uses REST API. Currently there is no formal Szurubooru from version 0.9+ uses REST API. Currently there is no formal
documentation; source code behind REST layer lies in `src/controllers/` documentation; source code behind REST layer lies in `src/Controllers/`
directory. In order to use the API, bear in mind that you need to: directory. In order to use the API, bear in mind that you need to:
1. Have actual user account on the server to do most things (depending on 1. Have actual user account on the server to do most things (depending on