From 88e6fc4181d9070da2881ac4b5185552379fa4b9 Mon Sep 17 00:00:00 2001
From: Sander Schobers <sander@schobers.eu>
Date: Sun, 15 Aug 2021 08:45:51 +0200
Subject: [PATCH] Put more emphasis on Allegro in the README. Added Allegro
 license to the README.

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++------------------
 TODO.md   |  1 +
 2 files changed, 39 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index bd716f7..ab235ef 100644
--- a/README.md
+++ b/README.md
@@ -2,23 +2,25 @@
 
 ## Content
 
-- [Introduction](##Introduction)
-- [Additional Rules](##Additional-Rules)
-   * [Implementation](###Implementation)
-   * [Definition](###Definition)
-- [Building](##Building)
-- [Sources](##Sources)
-- [Licenses (third party)](##Licenses)
-   * [Go-SDL2](###Go-SDL2)
-   * [SDL 2.0](###SDL-2.0)
-   * [Fira Mono font](###Fira-Mono-font)
-   * [Escher font](###Escher-font)
-   * [Escheresk font](###Escheresk-font)
-   * [fauxgl](###fauxgl)
-   * [draw2d](###draw2d)
-   * [go-colurful](###go-colurful)
-   * [resize](###resize)
-   * [testify](###testify)
+- [Introduction](#introduction)
+- [Additional Rules](#additional-rules)
+   * [Implementation](#implementation)
+   * [Definition](#definition)
+- [Building](#building)
+   * [Using Allegro](#using-allegro)
+- [Sources](#sources)
+- [Licenses (third party)](#licenses)
+   * [Go-SDL2](#go-sdl2)
+   * [SDL 2.0](#sdl-2-0)
+   * [Allegro 5](#allegro-5)
+   * [Fira Mono font](#fira-mono-font)
+   * [Escher font](#escher-font)
+   * [Escheresk font](#escheresk-font)
+   * [fauxgl](#fauxgl)
+   * [draw2d](#draw2d)
+   * [go-colurful](#go-colurful)
+   * [resize](#resize)
+   * [testify](#testify)
 
 ## Introduction
 
@@ -113,6 +115,8 @@ Prerequisites:
 - GCC or a compatible compiler.
 - [Git](https://git-scm.com/download).
 
+**Note:** the SDL 2.0 dependency can be replaced with [Allegro 5](#Using-Allegro) as well.
+
 With all prequisites installed you can run:
 ```
 go get -u opslag.de/schobers/tins2021/cmd/tins2021
@@ -124,12 +128,14 @@ go generate opslag.de/schobers/tins2021/cmd/tins2021
 go install -tags static -ldflags "-s -w" opslag.de/schobers/tins2021/cmd/tins2021
 ```
 
+### Using Allegro
+
 If you want to use the Allegro backend you can add the build tag `allegro` to the `go install` command. E.g.:
 ```
 go get -u opslag.de/schobers/allg5
 go install -tags static,allegro -ldflags "-s -w" opslag.de/schobers/tins2021/cmd/tins2021
 ```
-In this case the SDL 2.0 prerequisite is replaced by the Allegro 5.2 (development libraries must be available for your C compiler).
+In this case the SDL 2.0 prerequisite is replaced by Allegro 5.2 (development libraries must be available for your C compiler).
 
 ## Command line interface
 You can extract all resources embedded in the executable by running it from the command line with the `--extract` flag. The resources will be extract in the current working directory. Note that the game will use the resources on disk first if they are available.
@@ -185,6 +191,20 @@ 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.
 
+### Allegro 5
+
+Copyright © 2008-2010 the Allegro 5 Development Team
+
+This software is provided ‘as-is’, without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
+The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
+
+Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
+
+This notice may not be removed or altered from any source distribution.
+
 ### Fira Mono font
 
 Copyright (c) 2012-2013, The Mozilla Corporation and Telefonica S.A.
diff --git a/TODO.md b/TODO.md
index 1e8c089..7610887 100644
--- a/TODO.md
+++ b/TODO.md
@@ -13,3 +13,4 @@
 - [ ] Add audio settings (music & sound volume).
 - [X] Hearts must be saved as well for resume.
 - [ ] Add demo mode.
+- [ ] Add touch controls