diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..631f52d --- /dev/null +++ b/LICENSE @@ -0,0 +1,29 @@ +BSD 3-Clause License + +Copyright (c) [year], [fullname] +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +* Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4a612c9 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# cardmaker + +This is a simple cardmaker i made for our homebrew tabletop RPG. It is a simple webserver running locally, allowing you to make and manage your card deck. It uses *sanic+uvloop* to serve http, *airspeed* to render velocity templates and pyYAML to store and parse the cards. + +## dependencies: + +This requires python 3.6 or newer, and could perhaps be reworked into working with python 3.5. +The required python dependencies are listed in requirements.txt: + + pip install -r requirements.txt + +## running the server + +If you have a working install of [entr](http://entrproject.org/), then you can start the server running: + + ./dev.sh + +This will automatically restart the server any time you write any changes to it. + +If can otherwise run the server using + + python server.py + +When the server is running, you should be able to access it at [localhost:8000](http://localhost:8000) + +## Lisence + +This is release under BSD 3-clause license, see the file LICENSE for more information