aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaria Carolin Chabowski <laria@laria.me>2020-02-10 22:49:19 +0100
committerLaria Carolin Chabowski <laria@laria.me>2020-02-10 22:53:30 +0100
commit6b9c3fa57998b2ef74104d20f69ebbd4ee11a9c7 (patch)
treeb33939b161b9f666a828f116597c7a3ad0d7c432
parent62b0b360fa8a1a2d1fd6d89d4d227a0ef559cb8a (diff)
downloadmicropoly-6b9c3fa57998b2ef74104d20f69ebbd4ee11a9c7.tar.gz
micropoly-6b9c3fa57998b2ef74104d20f69ebbd4ee11a9c7.tar.bz2
micropoly-6b9c3fa57998b2ef74104d20f69ebbd4ee11a9c7.zip
Add README
Not that useful yet, but you gotta have a README!!
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..84e7575
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# micropoly
+
+A very simple, very WIP note management app.
+
+## Run it
+
+- Have PHP 7.4 with SQLite installed
+- Run `composer install`
+- Run the PHP development server like this `php -S localhost:8080 index.php`
+
+You can probably also run it on Apache or nginx+php-fpm but it's not yet tested.
+Also there is no user management yet, so it's not probably not wise to run it on a proper, public-facing webserver...
+
+## Documentation
+
+None (yet?). You're on your own. Good luck!