Merge branch 'main' of https://github.com/kannibalox/PtpUploader into…

… main
kannibalox · Jul 16, 2022 · 613480e · 613480e
2 parents eb425fb + e5d3da4
commit 613480e
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 43 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -1,13 +1,51 @@
-# Usage
+# Installation details
+
+PtpUploader needs Python 3.7+, as well as a couple other programs.
+The docker image contains all these images by default, and most distrubutions
+provide easy-to-install packages.
+
+Required external programs:
+- rTorrent or transmission
+  - if transmission is being used, the `transmissionrpc` package must be installed
+- One of: mpv (preferred), ffmpeg, mplayer
+- Mediainfo
+
+Optional external programs:
+- ImageMagick: Highly recommended for losslessly compressing PNG screenshots
+- FlexGet: Can be used to write announce files
+- autodl-irssi: Can	be used	to write announce files
+
+## Upgrading
+
+### Pip
+
+```bash
+pip install -U PtpUploader
+```
+
+### Docker
+
+When stopping the daemon in docker, be sure to fully remove the existing container:
+```bash
+sudo docker rm ptpuploader
+```
+
+```bash
+cd PtpUploader
+git pull
+# Re-do installation steps
+```
+
+# Usage
 
 ## Uploading
 
-To start your first upload, go to `localhost:8000/upload`, and use the form to fill out as much
+To start your first upload, go to http://localhost:8000/upload, and use the form to fill out as much
 information as possible about your upload. One of the first three fields (link, local path, or file)
 must be filled out, but anything else can be left blank, and PtpUploader will alert you if anything
 is missing.
 
-Once the job is submitted, it can viewed on the jobs page at `localhost:8000/jobs`.
+Once the job is submitted, it can viewed on the jobs page at http://localhost:8000/jobs.
 
 ## Automatic announcing
 
@@ -44,44 +82,6 @@ DATABASES:
     PORT: ''
 ```
 
-# Installation details
-
-PtpUploader needs Python 3.7+, as well as a couple other programs.
-The docker image contains all these images by default, and most distrubutions
-provide easy-to-install packages.
-
-Required external programs:
-- rTorrent or transmission
-  - if transmission is being used, the transmissionrpc package must be installed
-- One of: mpv (preferred), ffmpeg, mplayer
-- Mediainfo
-
-Optional external programs:
-- ImageMagick: Highly recommended for losslessly compressing PNG screenshots
-- FlexGet: Can be used to write announce files
-- autodl-irssi: Can	be used	to write announce files
-
-## Upgrading
-
-### Pip
-
-```bash
-pip install -U PtpUploader
-```
-
-### Docker
-
-When stopping the daemon in docker, be sure to fully remove the existing container:
-```bash
-sudo docker rm ptpuploader
-```
-
-```bash
-cd PtpUploader
-git pull
-# Re-do installation steps
-```
-
 # Command line only usage
 
 PtpUploader can create release description (with media info and screenshots) for manual uploading from command line.

diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ PtpUploader runuploader
 ```bash
 PtpUploader createsuperuser
 ```
-6. Navigate to [http://localhost:8000/jobs] and enter the admin credentials.
+6. Navigate to http://localhost:8000/jobs and enter the admin credentials.
 
 ### Docker
 
@@ -72,7 +72,7 @@ sudo docker run --name ptpuploader -d \
 ```bash
 sudo docker exec -it ptpuploader PtpUploader createsuperuser
 ```
-4. Navigate to [http://localhost:8000/jobs] and enter the admin credentials.
+4. Navigate to http://localhost:8000/jobs and enter the admin credentials.
 
 ## Next Steps and Help