Merge pull request #237 from EarthSchlange/docs_update_readme

docs: update README

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2012, 2013 American Go Association
+Copyright (c) American Go Association
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,29 +1,58 @@
-## AGAGD - the American Go Association Games Database
 
-The AGAGD is a django web application ported from the EuroGo Games Database to Python that provides:
+# The American Go Association Games Database (AGAGD)
 
-* member information,
-* top tournaments listings,
-* top players listings,
-* top active players,
-* insights into current and past tournaments.
+The `AGAGD` application is what runs [agagd.usgo.org](https://agagd.usgo.org). Originally, ported from the EuroGo Games Database, the `AGAGD` application now provides a means for members and non-members tournament information, chapter informaiton and member insights.
+
+## Contents
+
+* [Contributing](#contributing)
+* [Requirements](#requirements)
+* [Getting Started](#getting_started)
+* [Triage](#triage)
+* [Caveats](#caveats)
+* [License](#license)
 
 ## Contributing
 
-We welcome and encourage contributions to the AGAGD with Pull Requests (PRs), feature requests, bug reports, etc.
+We welcome any contributions. You could update documentation or our getting started or add a feature or find another way to improve the `AGAGD` application. Any contributions should be submitted as Pull Requests (PR). If you new to contributing on Github, take a look a the [First Contributions](https://firstcontributions.github.io/) project.
+
+## Requirements
+
+The `ÀGAGD` application uses Docker Compose and containers for local development. As such, we require that you have Docker and Docker compose installed on your system. To run our `AGAGD` application you currently need a `schema.sql` from the repository [usgo-sql-schemas](https://github.com/usgo/usgo-sql-schemas/blob/main/schema.sql).
+
+## Getting Started
+
+### Pre-Requisites
+
+* [Git](https://git-scm.com/)
+* [Docker](https://docs.docker.com/get-docker/)
+* [Docker Compose](https://docs.docker.com/compose/install/)
+* [schema.sql](https://github.com/usgo/usgo-sql-schemas/blob/main/schema.sql)
+
+### Get a local copy of `schema.sql`
+
+`$ curl -sSL https://raw.githubusercontent.com/usgo/usgo-sql-schemas/main/schema.sql -o schema.sql`
+
+### Run the `AGAGD` application using
+
+`$ docker-compose up`
+
+### Run tests for the `AGAGD` application using
+
+`$ docker-compose -f docker-compose.test.yml run test_app`
 
-## Database Prerequisites
+### The `AGAGD` app should now be running at
 
-Contributors submitting Pull Requests (PRs) will require a `schema.sql` file within their local AGAGD repository. The `schema.sql` can be found in [USGO SQL Schema's Repo](https://github.com/usgo/usgo-sql-schemas).
+[http://localhost:8000](http://localhost:8000)
 
-## Project Priorities
+## Triage
 
 [Bug Triage](https://github.com/usgo/agagd/projects/1) project for the AGAGD which lists and organizes current priorites the AGA Development Team has for the AGAGD.
 
-## Additional Documentation
+## Caveats
 
-* [/docs](/docs)
+* By default, the fake_data fixture data will be re-installed on every run of the app. This may erase any local changes you made previously. To disable this functionality, you can create a `docker-compose.override.yml` file and set `LOAD_FIXTURES` to `"false"`. See the [docker-compose documentation](https://docs.docker.com/compose/extends/#understanding-multiple-compose-files) for more information on overriding docker-compose values.
 
 ## License
 
-The AGAGD is licensed under the MIT License which can be found in [LICENSE](/LICENSEE).
+MIT © [American Go Association](/LICENSE)