Create a readme file

readme.md

@@ -0,0 +1,50 @@
+#### YouTube to PSP converter
+
+This project allows you to download and convert YouTube videos, to watch them on your PSP.
+
+#### Installation
+
+Clone the repository to your computer.
+```bash
+git clone https://git.nixmagic.com/vim/convert-psp
+```
+
+#### Execution
+
+Create a JSON file named `subscriptions.json` containing the subscriptions.
+The syntax is like so:
+
+```javascript
+{
+	"subscriptions": [
+		{
+			"name": "Channel",
+			"link": "https://www.youtube.com/@channel"
+		},
+		{
+			"name": "Playlist",
+			"link": "https://www.youtube.com/watch?v=something&list=playlist"
+		}
+	]
+}
+```
+
+Run the program.
+
+```bash
+./convert-psp
+```
+
+#### Transfer
+
+Copy the contents of the `PSP` directory into the `VIDEO` directory on your PSP.
+
+#### Storage considerations
+
+While considerations were made to lower the storage consumption as much as possible, the storage consumption may still be significant. Depending on the amount of content you add to your subscriptions file, prepare to have the video files take as much as 100GB of storage. On your PSP, I'd recommend getting a MS Pro Duo to micro SD card adapter, and to use a 128 or 256GB micro SD card. Make sure that the adapter supports SDXC.
+
+#### Conversion considerations
+
+While considerations were made to maximize the efficiency of the conversions, this still takes a significant amount of resources on your computer. Please only run this script on a computer that can run at 100% load for several hours at a time, such as a gaming computer. If you run this script on an inadequate machine (e.g. non-gaming laptops), your machine may overheat and cause permanent damage. You have been warned.
+
+The frame rate meanwhile appears to be around 500 FPS on my Lenovo IdeaPad Y700 gaming laptop. Newer laptops and especially desktop computers may be able to achieve higher frame rates still. However, for entire channels, the conversions can take several hours.