From f2efd781f1157dcbc26f59a120259957eed1948c Mon Sep 17 00:00:00 2001 From: Marcin Kurczewski Date: Sat, 18 Oct 2014 17:48:11 +0200 Subject: [PATCH] Added README --- INSTALL => INSTALL.md | 0 README.md | 59 +++++++++++++++++++++++++++++++++++++++++++ TODO | 2 -- 3 files changed, 59 insertions(+), 2 deletions(-) rename INSTALL => INSTALL.md (100%) create mode 100644 README.md diff --git a/INSTALL b/INSTALL.md similarity index 100% rename from INSTALL rename to INSTALL.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..bac02fff --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +szurubooru +======== + +## What is it? + +Szurubooru is a Danbooru-style board, a gallery where users can upload, browse, +tag and comment images, video clips and flash animations. + +Its name have its roots in Polish language and has onomatopoeic meaning of +scraping or scrubbing. It is pronounced *"shoorubooru"* [ˌʃuruˈburu]. + +## Licensing + +Please see the file named `LICENSE`. + +## Installation + +Please see the file named `INSTALL.md`. + +## Bugs and feature requests + +All bugs and suggestions should be reported as issues on the [Github +repository page](https://github.com/rr-/szurubooru/issues). When reporting, +please do following: + + 1. Search for existing issues for possible duplicates. If something is related + to your problem, comment on that issue instead of opening a new one. + 2. If you found an issue and the issue is closed, feel free to reopen it. + 3. If you're reporting a bug, create an isolated and reproducible scenario. + 4. If you're filing a feature request, provide examples - what might be obvious + to you, might not be so obvious to the developers. + +## Contributing the code + +Here are some guidelines on how to contribute: + + - Keep your changes compact. + - Respect coding standards - be consistent with existing code base. + - Watch your whitespace - don't leave any characters at the end of the lines. + - Always run tests before pushing. + - Before starting, see `INSTALL.md`. + - Use `grunt` to do automatic tasks like minifying `JS` files or running + tests. Run `grunt --help` to see full list of available tasks. + +## API + +Szurubooru from version 0.9+ uses REST API. Currently there is no formal +documentation; source code behind REST layer lies in `src/controllers/` +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 + privileges). + 2. Authenticate your requests: + 1. Send user credentials to `/auth`. You'll receive authentication token in + return. + 2. Send this token in X-Authorization-Token header on subsequent requests. + +Developers reserve right to change API at any time with neither prior notice +nor keeping backwards compatibility. diff --git a/TODO b/TODO index 5c7f148c..dfc1fb2c 100644 --- a/TODO +++ b/TODO @@ -12,8 +12,6 @@ first major release. - tags: add tag descriptions - tags: add tag edit snapshots (backed-only) - misc: endless pager should include information about page number -- misc: add README - apache2 has good README: - http://svn.apache.org/repos/asf/httpd/httpd/trunk/README - misc: add spinner to forms such as registration, login, settings... - misc: improve throbber appearance