diff --git a/README.md b/README.md index fdf901dd..a42e6502 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,7 @@ sudo apt-get install imagemagick libcairo2-dev libjpeg-dev libpango1.0-dev libgi See [SERVER.md](/SERVER.md) for a thorough deployment setup guide. +#### Setup ``` bash cd process @@ -55,6 +56,11 @@ npm install cd .. +``` + +#### Process all +``` bash + # run script including downloading latest data and processing sprites npm run process -- download @@ -68,6 +74,19 @@ npm run process -- sounds npm run process ``` +#### Process specifc objects +You can selectively process the sprites of specific objects. + +This can be useful for local development of Twotech or OneLifeData7. + +``` bash +# Download argument required first run +npm run process-specific-objects 404 download + +# Many objects can be specified +npm run process-specific-objects 15633,11106,404 +``` + ### Processing Script (Docker version) > Note 1: This is for a Linux machine with Docker installed.