add licence and readme

2 files changed, 47 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..0ee180d
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright 2024 winter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7eea76b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# digitigrade
+
+an experimental server for the also-experimental pawpub federated social media
+protocol.
+
+## running the server
+
+**it is not in a usable state yet!** nothing useful will happen by running it,
+unless you're working on it.
+
+you should have:
+
+* php >= 8.3
+* composer
+* a postgres server, database and user already set up
+* a beanstalkd server already running
+
+the basic steps for setup are:
+
+1. run `composer install`
+2. edit config.ini as appropriate
+3. set up the database with `bin/migrate`
+4. run the development server with `php -S 0.0.0.0:8080 index.php` or set it up
+   with fpm in your web server
+5. run at least one worker with `bin/worker`
+
+you can poke around with `bin/shell` which will launch the interactive php
+shell and initialise all the composer autoloads and so on