From 3af32f2436dc857cb2dbc26f5314d87d2a319ab1 Mon Sep 17 00:00:00 2001 From: Tim Pilius Date: Mon, 24 Oct 2022 23:09:03 -0400 Subject: [PATCH] Switching over to github pages documentation --- README.md | 12 +++-- .../Install-Guide-For-Linux-Beginners.md | 2 +- docs/mkdocs/test.md | 50 ------------------- 3 files changed, 10 insertions(+), 54 deletions(-) delete mode 100644 docs/mkdocs/test.md diff --git a/README.md b/README.md index e11a4e68..c489c7a4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # steam-lancache-prefill -[![](https://dcbadge.vercel.app/api/server/BKnBS4u?style=flat-square)](https://discord.com/invite/BKnBS4u) +[![](https://dcbadge.vercel.app/api/server/BKnBS4u?style=for-the-badge)](https://discord.com/invite/BKnBS4u) +[![view - Documentation](https://img.shields.io/badge/view-Documentation-green?style=for-the-badge)](https://tpill90.github.io/steam-lancache-prefill/) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Y8Y5DWGZN) + Automatically fills a [Lancache](https://lancache.net/) with games from Steam, so that subsequent downloads for the same content will be served from the Lancache, improving speeds and reducing load on your internet connection. Overview @@ -26,6 +28,10 @@ Automatically fills a [Lancache](https://lancache.net/) with games from Steam, s - [Need Help?](#need-help) ## Initial Setup + +> **Note** +> New to Linux? See this detailed tutorial : [Install Guide For Linux Beginners](https://tpill90.github.io/steam-lancache-prefill/install-guides/Install-Guide-For-Linux-Beginners/) + 1. Download the latest version for your OS from the [Releases](https://github.com/tpill90/steam-lancache-prefill/releases) page. 2. Unzip to a directory of your choice 3. (**Linux / OSX Only**) Give the downloaded executable permissions to be run with `chmod +x ./SteamPrefill` @@ -113,7 +119,7 @@ For more brand specific guides (non-exhaustive), see : # Detailed Command Usage > **Note** -> Detailed command documentation has been moved to the wiki : [Detailed Command Usage](https://github.com/tpill90/steam-lancache-prefill/wiki/Detailed-Command-Usage) +> Detailed command documentation has been moved to the wiki : [Detailed Command Usage](https://tpill90.github.io/steam-lancache-prefill/Detailed-Command-Usage/) # Updating **SteamPrefill** will automatically check for updates, and notify you when an update is available : @@ -138,7 +144,7 @@ If you are running into any issues, feel free to open up a Github issue on this You can also find us at the [**LanCache.NET** Discord](https://discord.com/invite/BKnBS4u), in the `#steam-prefill` channel. # Additional Documentation -* [Development Configuration](https://github.com/tpill90/steam-lancache-prefill/wiki/Development-Setup) +* [Development Configuration](https://tpill90.github.io/steam-lancache-prefill/dev-guides/Compiling-from-source/) # Acknowledgements - [@dlrudie](https://github.com/dlrudie) for all your help with debugging and testing! diff --git a/docs/mkdocs/install-guides/Install-Guide-For-Linux-Beginners.md b/docs/mkdocs/install-guides/Install-Guide-For-Linux-Beginners.md index 8fdcc1a0..b1942b4a 100644 --- a/docs/mkdocs/install-guides/Install-Guide-For-Linux-Beginners.md +++ b/docs/mkdocs/install-guides/Install-Guide-For-Linux-Beginners.md @@ -1,6 +1,6 @@ # Install Guide For Linux Beginners -This small guide is written to help beginners to Linux download SteamPrefill on their lancache caching server. +This guide is written to help Linux beginners successfully download **SteamPrefill** on their Lancache caching server. ## Installing Prerequisites diff --git a/docs/mkdocs/test.md b/docs/mkdocs/test.md deleted file mode 100644 index bd83717f..00000000 --- a/docs/mkdocs/test.md +++ /dev/null @@ -1,50 +0,0 @@ -Title: My Document -Summary: A brief description of my document. -Authors: Waylan Limberg - John Doe -Date: October 2, 2007 -blank-value: -base_url: http://example.com - -This is the first paragraph of the document. - -!!! note - You should note that the title will be automatically capitalized. - -!!! danger "Don't try this at home" - ... - -!!! important "" - This is an admonition box without a title. - -!!! type "optional explicit title within double quotes" - Any number of other indented markdown elements. - - This is the second paragraph. - -!!! danger highlight "Don't try this at home" - ... - - -Apple -: Pomaceous fruit of plants of the genus Malus in - the family Rosaceae. - -Orange -: The fruit of an evergreen tree of the genus Citrus. - -``` html -

HTML Document

-``` - -1. Ordered item 1 -2. Ordered item 2 - -* Unordered item 1 -* Unordered item 2 - -[TOC] - -# Header 1 - -## Header 2 \ No newline at end of file