docs: formalize README

This commit is contained in:
rr- 2016-03-31 23:40:36 +02:00
parent da3faa556f
commit 7e26fc87ce

View file

@ -1,23 +1,19 @@
This is rewrite of `szurubooru` 0.9.x that intends to This is rewrite of [`szurubooru` 0.9.x](https://github.com/rr-/szurubooru) that
intends to:
- Improve user experience within frontend. No more vertical user list. Better - Improve user experience: better upload form, larger thumbnails, make top
upload form, larger thumbnails, make top navigation stay out of user way. navigation stay out of user way. Maybe other goodies!
Maybe other goodies! - Finally define sane REST API without unnecessary blobs and with proper
- Finally define sane REST API (with no bullshit such as SQL queries, request documentation.
timings or exception stack traces this time) - Simplify registration - user registers, and they're able to post. (You'll
- Simplify registration - user registers, and they're able to post. No still be able to make it kind of invite-only via default permissions.)
activation e-mails, no nothing (email's going to be used **ONLY** for - Replace PHP with Python 3.5.
password reminders, yes, *not even* for confirmation). Note that you will - Replace prior JS mess with proper MVC.
have control over permissions, user ranks and the default user rank, so you - Replace MySQL (MariaDB) with Postgres.
might be able to setup a system where user needs to be approved by mod to - Replace `composer`, `npm`, `mod_rewrite` (=Apache), `imagick`, `pdo_mysql`
join the community. with just `pip` and `npm` (+ sandboxed dependencies).
- Maybe simplify permission system - Replace `grunt` with `npm` scripts.
- Ditch PHP in favor of something more serious (python 3.5) - Make hosting more flexible: offer simple self hosted app that can be combined
- Ditch in-house JS monstrosities in favor of something more serious (I've got with any reverse proxy.
EmberJS on my radar) - Reduce codebase size - the original szurubooru was at 30KSLOC (`git
- Replace dependencies such as composer, npm, grunt, and all that crap with line-summary`), let's see how much this can be brought down.
just python, and a few pip packages
- Simplify hosting: offer simple self hosted app combinable with reverse proxies
- Replace MySQL (/ MariaDB) with Postgres
- Less god damn code! 24KSLOC? For a thing this simple? The goal is to fit
within 15KSLOC. Let's see if I can accomplish this.