Browse Source

wip doc

main
squeaky otter 5 months ago
parent
commit
80209610a9
Signed by: dashie GPG Key ID: C2D57B325840B755
  1. 21
      LICENSE
  2. 25
      README.md

21
LICENSE

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2017-2018 Dashie <dashie@sigpipe.me>
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.

25
README.md

@ -0,0 +1,25 @@
camgear
=====================
<a href="https://dev.sigpipe.me/dashie/camgear/src/branch/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg"/></a>
<img src="https://img.shields.io/badge/python-%3E%3D3.6-blue.svg"/> [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
# Versions requirement
- Python >= 3.6 (all under 3.6 are not supported) (say bye-bye to debian stable, sorry)
- try https://github.com/chriskuehl/python3.6-debian-stretch if you use debian stable
# Installation
Install a BDD (mysql is supported, SQLite maybe, PostgreSQL should be)
Makes sure that encoding is/will be in UNICODE/UTF-8
git clone https://github.com/rhaamo/camgear
cd camgear
pip3 install --requirement requirements.txt
TODO
# Creating an user
Use the ``` python manage.py createsuperuser ``` command to create a super user.
# Licensing
- MIT License
Loading…
Cancel
Save