Skip to content

Commit 33a2f1f

Browse files
committed
Update README.md
1 parent 2231996 commit 33a2f1f

File tree

8 files changed

+57
-18
lines changed

8 files changed

+57
-18
lines changed

README.md

Lines changed: 57 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,37 @@
22

33
An online game that's like _Where's Waldo?_ but for houses
44

5-
## Description
5+
## Table of Contents
66

77
> [!NOTE]
88
> ALL CONTENTS IN THIS REPO ARE FOR EDUCATIONAL PURPOSES ONLY.
99
10-
_Geofinder_ is an online scavenger hunt game. Its gameplay is simple: Given a photo of a house somewhere in the world, your task is to look for that house inside a marked area on a map. While that may sound straighforward, how you will go about looking might not be.
10+
* [Description](#description)
11+
* [Target Users](#target-users)
12+
* [Features](#features)
13+
* [Project Structure](#project-structure)
14+
* [Prerequisites](#prerequisites)
15+
* [Quick Start](#quick-start)
16+
* [Local Setup](#local-setup)
17+
* [Dependencies](#dependencies)
18+
* [Installation](#installation)
19+
* [Configuration](#configuration)
20+
* [Production Setup](#production-setup)
21+
* [Usage](#usage)
22+
* [System Administration](#system-administration)
23+
* [Author(s)](#authors)
24+
* [Version History](#version-history)
25+
* [Release Notes](#release-notes)
26+
* [Initial Release](#initial-release)
27+
* [Future Work](#future-work)
28+
* [License](#license)
29+
* [Contributing](#contributing)
30+
* [Acknowledgments](#acknowledgments)
31+
* [Screenshots](#screenshots)
32+
33+
## Description
34+
35+
_Geofinder_ is an online scavenger hunt game. Its gameplay is simple: Given a photo of a house somewhere in the world, your task is to look for that house inside a marked area on a map. While that may sound straightforward, how you will go about looking might not be.
1136

1237
_Geofinder_ comes in two modes.
1338

@@ -18,25 +43,27 @@ _Geofinder_ is inspired by such childhood games as _[Where's Waldo?](https://en.
1843

1944
![Screenshot](docs/images/geofinder_00.png)
2045

21-
More screenshots below.
22-
23-
## Table of Contents
46+
## Target Users
2447

25-
TODO
48+
* TBD
2649

2750
## Features
2851

29-
TODO
52+
* TBD
3053

3154
## Project Structure
3255

33-
TODO
56+
* TBD
3457

3558
## Prerequisites
3659

37-
TODO
60+
* TBD
61+
62+
## Quick Start
3863

39-
## Getting Started
64+
* TBD
65+
66+
## Local Setup
4067

4168
### Dependencies
4269

@@ -71,7 +98,7 @@ TODO
7198

7299
5. **Set up a PostgreSQL Database:**
73100

74-
TODO
101+
TBD
75102

76103
6. **Set up a Google Maps API Key:**
77104

@@ -85,9 +112,17 @@ TODO
85112

86113
Create a file named `.env` in the `app` directory of the project and add the following variables:
87114

88-
TODO
115+
TBD
116+
117+
### Configuration
118+
119+
* TBD
120+
121+
## Production Setup
89122

90-
### Usage
123+
* TBD
124+
125+
## Usage
91126

92127
1. **Go into the app directory and run the command:**
93128

@@ -101,11 +136,15 @@ TODO
101136

102137
3. **Register an account:**
103138

104-
TODO
139+
TBD
105140

106141
4. **Login:**
107142

108-
TODO
143+
TBD
144+
145+
## System Administration
146+
147+
* TBD
109148

110149
## Author(s)
111150

@@ -119,7 +158,7 @@ TODO
119158

120159
### Initial Release
121160

122-
The [initial realease](https://github.com/ggeerraarrdd/geofinder/releases/tag/v1.0.0) of _Geofinder_, as _Geo50x_, was submitted as the final project for [CS50x: CS50's Introduction to Computer Science](https://cs50.harvard.edu/x/2023/) (HarvardX, 2023). Read the [project brief](https://cs50.harvard.edu/x/2023/project/) as of September 2023.
161+
The [initial release](https://github.com/ggeerraarrdd/geofinder/releases/tag/v1.0.0) of _Geofinder_, as _Geo50x_, was submitted as the final project for [CS50x: CS50's Introduction to Computer Science](https://cs50.harvard.edu/x/2023/) (HarvardX, 2023). Read the [project brief](https://cs50.harvard.edu/x/2023/project/) as of September 2023.
123162
124163
## Future Work
125164
@@ -131,12 +170,12 @@ Development is ongoing.
131170
132171
## Contributing
133172
134-
TODO
173+
* TBD
135174
136175
## Acknowledgments
137176
138177
* The distribution code for CS50's Finance problem served as a template for the app.
139-
* The documentions for the Google Maps Platform were a daily, often hourly, read.
178+
* The documentations for the Google Maps Platform were a daily, often hourly, read.
140179
* Too many StackOverflow [Q&As](https://meta.stackoverflow.com/questions/267822/if-stack-overflow-doesnt-have-threads-what-the-heck-should-they-be-called) and Medium articles to mention but a couple proved immensely useful in developing two key functions
141180
* [Offset Latitude and Longitude by some meters accurately - Reverse Haversine](https://gis.stackexchange.com/questions/411859/offset-latitude-and-longitude-by-some-meters-accurately-reverse-haversine)
142181
* [Algorithm for offsetting a latitude/longitude by some amount of meters](https://gis.stackexchange.com/questions/2951/algorithm-for-offsetting-a-latitude-longitude-by-some-amount-of-meters)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)