From ed8723ee6b614ee16526af71f71e0b3f5cf2d759 Mon Sep 17 00:00:00 2001 From: irl Date: Sun, 5 Apr 2026 11:22:30 +0100 Subject: [PATCH] docs: add BSD licence and translations details --- LICENCE | 22 ++++++++++++++++++++++ README.md | 34 ++++++++++++++++++++++++++++++---- 2 files changed, 52 insertions(+), 4 deletions(-) create mode 100644 LICENCE diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..4f6fb3f --- /dev/null +++ b/LICENCE @@ -0,0 +1,22 @@ +Copyright 2025-2026 SR2 Communications Limited. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list + of conditions and the following disclaimer. + +2. 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. + +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 index 2e12771..0b138f8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ -## Butter Portal +Butter Portal +============= -This is a flask application that will replace the current static butterbox portal. -Some screenshots: +[![Translation status](https://hosted.weblate.org/widget/sr2/butter-portal/svg-badge.svg)](https://hosted.weblate.org/engage/sr2/) +[![License](https://img.shields.io/badge/License-BSD_2--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause) + +This is a [Flask](https://palletsprojects.com/projects/flask/) application that +serves as the primary UI for the [Butter Box](https://likebutter.app/) project. +This is a from scratch reimplementation of the original UI with new enhancements +and features. + +Screenshots +----------- @@ -10,4 +19,21 @@ Some screenshots: - \ No newline at end of file + + +Translations +------------ + +Snapshot templates support localisation. +Translations of strings in the template are managed on Weblate. + + +Translation status + + +Licence & Copyright +------------------- + +© SR2 Communications Limited. See [LICENCE](./LICENCE) for details of the +BSD 2-clause licence. +