Add readme and contributing guide.

2 files changed, 69 insertions, 0 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..6241295
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# Contributing
+
+Contributions to this program are welcome under the terms of the GNU Affero
+General Public License, as specified in the LICENSE file in this repository.
+
+A mailing list has been set up for administering the development of this
+program. Subscribe here:
+https://volse.anduin.net/mailman/listinfo/skrekkpatches
+
+You can submit patches or requests directly to the list, even without
+subscribing, but we recommend subscribing to make sure you will be part of any
+discussions with regards to the patches.
+
+For big patches or longer series of patches we prefer a publicly available git
+branch we can clone or merge into the main repo. Again submit information about
+where the branch is available on the mailing list.
+
+For sequrity related bugs and patches, please don't post details on the list,
+but ask us for a contact to submit the details too.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d40b020
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# Ramaskrik Social Program
+
+**Note:** This is an inofficial application, and not endorsed by or supported by the Ramaskrik organizers.
+
+**Note 2:** This is still very early in development, progress is slow, and the entire app may change drastically or even be abandoned without notice. The hope is that it will be finished by Ramaskrik 2019, though.
+
+The _Ramaskrik Social Program_ is meant to be a rather simple app that gives you the time and room for the various screenings at the Ramaskrik Horror Film Festival. In addition to just showing you the program, you should be able to plan your route through the program, as well as share comments and grades for each film if you want to. To make sure the app is available to any device or platform, it will be implemented as a standard web application.
+
+This is also an experiment to see if it is possible to make a small social app for a specific event be both fun and safe without requiring formal registration and tracking.
+
+## Guidelines
+
+I beleive strongly in your right to privacy and that you should be in control over what you want to share, and even if you want to share anything back at all. Therefore a few goals and guidelines is laid out to guide the development.
+
+### The user should be in control over what they want to share, if anything at all.
+
+This means that you should be able to use the app without sharing anything at all. The app should not require any registration, and it should limit logging or otherwise tracking access to the minimum needed to operate the app. Only content that is explicitly shared by the user will be stored on our server.
+
+### The user should be in control over how they appear in content they choose to share.
+
+This means that you can choose wether you want your submissions to carry your name, some pseudonym, or just be anonymous.
+
+### The app should be a fun and safe space for everyone.
+
+Moderators will be able to remove offensive, threatening or harrassing content, and for particularly grave or repeat offenses, block the offending device from reconnecting to the app.
+
+## Runtime stack
+
+The app consist of a server part and a front end part. The server is written in Rust using Rocket and Diesel as the web- and database framework respectively. The front end is written in HTML5 and JavaScript.
+
+## Contributing
+
+Patches, suggestions, artwork and other contributions are most welcome. See _CONTRIBUTING_ for information on how to send me your contributions. All code contributed must be licensed as AGPLv3 as per the LICENCE file in this repository.
+
+## License
+
+    Copyright (C) 2019  Harald Eilertsen
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.