Skip to content

Commit

Permalink
Rearrange readme to put features on top
Browse files Browse the repository at this point in the history
  • Loading branch information
xdpirate committed Nov 20, 2023
1 parent 72f5fb7 commit 82c6a29
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,6 @@ Simple self-hosted tracker to keep track of upcoming, current and collected game

![2023-06-30_18-30](https://github.com/xdpirate/gamehorizon/assets/1757462/c9c55c78-fbba-4d66-8dd8-882728f9a4ad)

## Requirements

You can run GameHorizon on your own AMP stack, or via Docker.

### AMP stack

* A web server
* A SQL server
* PHP

GameHorizon is developed and tested using Apache2 and MySQL, but other web servers and SQL servers will probably work. Maybe.

### Docker

* Docker and Docker Compose

## Usability

It works as intended. It doesn't look too hot on phones at the moment, owing to the horizontal table layout of the games. It looks nice on a tablet-style display, though, or the inner screen of foldables. I'm planning to make a more mobile-friendly UI in the future, but focus right now is on the desktop experience.

## Features

* Add a game to one of four tables:
Expand All @@ -45,6 +25,22 @@ It works as intended. It doesn't look too hot on phones at the moment, owing to
* Names are not unique and can exist in several states and tables at once
* Built-in update mechanism

## Requirements

You can run GameHorizon on your own AMP stack, or via Docker.

### AMP stack

* A web server
* A SQL server
* PHP

GameHorizon is developed and tested using Apache2 and MySQL, but other web servers and SQL servers will probably work. Maybe.

### Docker

* Docker and Docker Compose

## Installation/Usage

### Running on preinstalled AMP stack
Expand Down Expand Up @@ -74,6 +70,10 @@ $mysqlPassword = "your-sql-password";
6. To stop, run `docker-compose stop` in the repository directory.
7. To update GameHorizon, run `git pull` in the repository directory (requires `git` to be installed).

## Usability

It works as intended. It doesn't look too hot on phones at the moment, owing to the horizontal table layout of the games. It looks nice on a tablet-style display, though, or the inner screen of foldables. I'm planning to make a more mobile-friendly UI in the future, but focus right now is on the desktop experience.

## Clean-up/Uninstallation

### AMP stack
Expand Down

0 comments on commit 82c6a29

Please sign in to comment.