Updating Readme with requirements, installation and usage info

This commit is contained in:
ilumos 2017-08-17 01:11:15 +01:00
parent f08e827ad2
commit 7cf8d9a83b

View file

@ -1,9 +1,56 @@
# lancache-autofill # lancache-autofill
Automatically fill a Lancache with content. 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 Reference](https://developer.valvesoftware.com/wiki/SteamCMD)
* [SteamCMD Commands and Variables](https://github.com/dgibbs64/SteamCMD-Commands-List/blob/master/steamcmdcommands.txt) * [SteamCMD Commands and Variables](https://github.com/dgibbs64/SteamCMD-Commands-List/blob/master/steamcmdcommands.txt)
* [jq Reference](https://stedolan.github.io/jq/manual/) * [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)