From 7cf8d9a83bef4abeceef3581c296cdf570abdd51 Mon Sep 17 00:00:00 2001 From: ilumos Date: Thu, 17 Aug 2017 01:11:15 +0100 Subject: [PATCH] Updating Readme with requirements, installation and usage info --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 733bcdd..232eeca 100755 --- a/README.md +++ b/README.md @@ -1,9 +1,56 @@ # lancache-autofill Automatically fill a Lancache with content. +# Requirements -# Useful Sites +* Ubuntu 16.04 x64 + +# Installation + +* `git clone https://github.com/zeropingheroes/lancache-autofill.git` +* `sudo ./install.sh` + +# Usage + +Log in to your Steam account to SteamCMD: + +`/usr/games/steam/steamcmd.sh +login your-username-here` + +Create the database structure: + +`./lancache-autofill app:create-database` + +Download the app list from Steam: + +`./lancache-autofill steam:update-app-list` + +Search for the apps you wish to download: + +`./lancache-autofill steam:search-apps "team fortress 2"` + + 440 Team Fortress 2 + [...] + +Queue the app for download: + +`./lancache-autofill steam:queue-app 440` + +Start downloading: + +`./lancache-autofill steam:start-downloading` + +View the download queue to see the status of the downloads: + +`./lancache-autofill steam:show-queue` + +Clear the temporary download location: + +`./lancache-autofill app:delete-downloads` + +# Reference * [SteamCMD Reference](https://developer.valvesoftware.com/wiki/SteamCMD) * [SteamCMD Commands and Variables](https://github.com/dgibbs64/SteamCMD-Commands-List/blob/master/steamcmdcommands.txt) -* [jq Reference](https://stedolan.github.io/jq/manual/) \ No newline at end of file +* [Laravel Query Builder](https://laravel.com/docs/5.4/queries) +* [Laravel Artisan Console](https://laravel.com/docs/5.4/artisan) +* [Symfony Process Component](http://symfony.com/doc/current/components/process.html) \ No newline at end of file