📄 Add list of SSN repositories

docs/setup-environment.md

@@ -1,19 +1,21 @@
-All tools are intended to be run on either WSL or Linux.
+# Setting up the environment
 
-# Setup
+This page describes what you need to install before you can run the tools from the various repositories. We expect that you use Windows 10.
+
+## Steps
 
 1. On Windows 10, install the Windows Subsystem for Linux (WSL) with either the Ubuntu or Debian distribution.
 
 2. Open a command line shell: Press Win+R and enter `bash`.
 
-2. Install Node.js ([source](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)):
+3. Install Node.js ([source](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)):
 
     ```bash
-    wget -qO- https://deb.nodesource.com/setup_10.x | sudo -E bash -
+    wget -qO- https://deb.nodesource.com/setup_11.x | sudo -E bash -
     sudo apt-get install -y nodejs
     ```
 
-3. Install npm modules:
+4. Install npm modules:
 
     ```bash
     sudo npm install -g typescript

repositories/ssn.md

@@ -0,0 +1,28 @@
+# SSN repositories
+
+An overview of all repositories related to the patcher (SSN).
+
+```plaintext
+      ssn-database
+           |
+     |------------|
+ ssn-auto     ssn-manager   ssn-tools
+     |------------|-------------|
+           |
+          ssn
+           |
+    ssn-installer
+```
+
+## Libraries
+
+- `argument-parser`: Abstracts parsing and verification of command line arguments. Used by `ssn-tools`.
+- `ssn`: A Node.js library that exports various functions to download and parse SSN files, both low-level and high-level.
+- `ssn-database`: Abstracts the data storage from `ssn-auto` and `ssn-manager`.
+- `ssn-installer`: A low-level tool for extracting patch files. Used by `ssn` and not recommended to call on its own; better to use the higher-level functions from `ssn`.
+
+## Endpoints
+
+- `ssn-auto`: A command line tool that automatically checks for and installs new patches. Intended to be run as a cron job.
+- `ssn-manager`: A GUI version of `ssn-auto` for debugging patch failures.
+- `ssn-tools`: Various command line tools for debugging SSN without writing code. More low-level than `ssn-manager`.