Merge pull request #30 from ComputerScienceHouse/willnilges/summarize

Summarize required resources for API and Website

Author: wilsonmcdade

docs/Hardware/installing-dcu.md

@@ -105,7 +105,7 @@ From the onboard directory, initialize the xlogin submodule by running:
     git submodule update --init --recursive
 
 To build the onboard program and put it in the correct place, run
-<!-- TODO Update idiot naming →
+<!-- TODO Update idiot naming -->
 ./idiot/update_onboard.sh
 cp idiot/.xinitrc /home/devcade
 mkdir -p /home/devcade/.config/openbox && cp idiot/rc.xml /home/devcade/.config/openbox

docs/Internals/API/README.md

@@ -1,5 +1,15 @@
 # API
 
+The API is used to interact with the game library by the cabinet and the website. It requires a few resources:
+- S3 Buckets
+    - Game Images
+    - Game Saves
+- Databases
+    - Postgres
+        - For storing information about games
+
+Source code can be found at: https://github.com/ComputerScienceHouse/devcade-api
+
 - Download project and run `npm install`
 - Use `npm run dev` to start the development server.
 - If a `.env` file does not currently exist in the repo root directory, create one with:
@@ -150,4 +160,4 @@ const upload = async () => {
 		throw err;
 	}
 }
-```
+```

docs/Internals/Website/README.md

@@ -1,6 +1,10 @@
 # devcade-website
 Front-end for the Devcade website that allows members to view the game catalog and upload games.
 
+Requires a database for storing session information. The goal of the userDB was to keep track of user data that we might add to the site at a later time. It is not currently used.
+
+Source code can be found at https://github.com/ComputerScienceHouse/devcade-website
+
 # How to Run
 `pip3 install -r requirements.txt`
 
@@ -49,4 +53,4 @@ os.environ["DEVCADE_DB_URI"] = ""
 os.environ["DEVCADE_API_URI"] = ""
 ```
 
-Note that this is just a template for the `envs.py` file. You will need to get these secrets from an RTP or Devcade developer.
+Note that this is just a template for the `envs.py` file. You will need to get these secrets from an RTP or Devcade developer.