{"id":13740229,"url":"https://github.com/sillsdev/ArtOfReading","last_synced_at":"2025-05-08T19:36:48.321Z","repository":{"id":141936948,"uuid":"117760884","full_name":"sillsdev/ArtOfReading","owner":"sillsdev","description":null,"archived":false,"fork":false,"pushed_at":"2020-01-14T14:50:04.000Z","size":2590,"stargazers_count":1,"open_issues_count":0,"forks_count":3,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-11-15T10:41:27.346Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sillsdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-01-17T00:34:38.000Z","updated_at":"2020-01-31T17:07:33.000Z","dependencies_parsed_at":"2024-01-07T18:10:37.364Z","dependency_job_id":null,"html_url":"https://github.com/sillsdev/ArtOfReading","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sillsdev%2FArtOfReading","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sillsdev%2FArtOfReading/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sillsdev%2FArtOfReading/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sillsdev%2FArtOfReading/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sillsdev","download_url":"https://codeload.github.com/sillsdev/ArtOfReading/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253135823,"owners_count":21859688,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T04:00:44.750Z","updated_at":"2025-05-08T19:36:45.930Z","avatar_url":"https://github.com/sillsdev.png","language":"JavaScript","readme":"# ArtOfReading\nThe Art Of Reading DVD contains TIFs, with no embedded metadata.\nArt Of Reading Free (this project) instead contains PNGs in which the license and\ncopyright are embedded in each image. AOR is currently distributed from http://bloomlibrary.org/artofreading. It can be used with any software that supports SIL's [simple image gallery format](https://github.com/sillsdev/image-collection-starter), including [Bloom](http://bloomlibrary.org) and [WeSay](http://software.sil.org/wesay).\n\nThe following instructions are for people working in Windows, but could be readily adapted for Linux.\n\n# 1) Clone (download) this repository to your machine\n\n(Click the green 'Clone or download' button above)\n\n# 2) Set up programs on your machine\n\nIf you don't know about setting the PATH variable, this process is probably going to be more technical than you are used to. The first 3 programs below will each need to have an entry in your Windows PATH variable, and you're going to have to add it. There are various tutorials. Here's a good Google query to use: https://www.google.com/search?q=set+windows+path+variable+-java\u0026oq=set+windows+path+variable+-java. Note that if you have a CMD window open, it won't \"see\" changes you've made to the PATH variable. You need to close the CMD window and re-open.\n\nAdd this folder (where this readme and process-images.bat are) to your PATH (this will help in finding pngout).\n\n## ExifTool\n\nExifTool is used to embed your intellectual property information into each image. Get it at http://www.sno.phy.queensu.ca/~phil/exiftool/ and install it. In April 2018, it does not have an actual installer, so here are some steps:\n1. Get the \"windows executable\", unzip it into this folder, alongside the file named 'process-images.bat'.\n2. Rename it from \"exiftool(-k).exe\" to just \"exiftool.exe\".\n\nVerify that if you open a new CMD window and cd to this folder, this command works:\n\n    exiftool -ver\n\nYou should see something like\n\n    x:\\dev\\image-collection-starter\u003eexiftool -ver\n    8.68\n\n## ImageMagick\n\nImageMagick used to convert TIF images to PNG.\n\nGet it at http://www.imagemagick.org/script/download.php. Get the first choice under \"Windows Binary Release\", and verify that if you open a new CMD window, this command works:\n\n    magick --version\n\nYou should see something like\n\n    x:\\dev\\image-collection-starter\u003emagick --version\n    Version: ImageMagick 7.0.7-1 Q16 x64 2017-09-09 http://www.imagemagick.org\n    Copyright: Copyright (C) 1999-2015 ImageMagick Studio LLC\n\n## PNGOut.exe\n\nPNGOut.exe is used to compress the daylights out of the png. Get it here: http://advsys.net/ken/utils.htm. Like exiftool, it lacks an installer. So put the file named pngout.exe in this folder, alongside the file named 'process-images.bat'. Type following command in a CMD window while cd'd into this folder:\n\n    pngout\n\nYou should see a bunch of documentation on how to use pngout, which you can ignore.\n\n## InnoSetup\n\nInnoSetup will make your installer. Get the unicode version here: http://www.jrsoftware.org/isdl.php\n\n# Setting up your image files\n\nGet the Art Of Reading TIFF Images from the DVD or art-of-reading-tiffs.tar (in 2017, this is in Bloom Team Google Drive). Place them in the /images folder, so that you have repository-root/images/Brazil, etc. (Hint: start with a small subset of images, verify the results, then go back and do the whole thing.)\n\nThere is currently no way here to read the index and embed things like the artist name or index terms into the image. See \"Embedded authors \u0026 keywords\" below for the current state of these things.\n\n# 2) Create the modified files\n\nWhat we want to do: for each image in /images/\n\tMake a PNG out of it in /output/processed-images, using ImageMagick.\n\tCompress it really well, using PNGOut.\n\tPush in metadata, using exiftool.\n\nRun\n\n    process-images.bat\n\nThat should create an /output folder and an /output/processed-images folder.\n\n# 3) Create the installer\n\nNow make an an installer. Double click the \"installer.iss\" file. InnoSetup should run. Click \"Build:Compile\". That should create \"/output/ArtOfReading.exe\". Now run that program. When it is done, look in %programdata%\\SIL\\ImageCollections\\. You should see a \"Art Of Reading\".\n\n# 4) Sign the installer\n\nWindows will make it scary for anyone to use the installer until it is signed by someone (e.g. SIL Intl).\n\n---\n## Relevant documentation on metadata\n\nhttp://www.sno.phy.queensu.ca/~phil/exiftool/TagNames/XMP.htm\n\nhttp://www.metadataworkinggroup.org/pdf/mwg_guidance.pdf\n\nThe idea is that we need an automated process that will take each image in the images/ directory, get it all ready, and deposit it in the /output/process-images directory. You never commit anything in /output to github; instead the installer maker will gather file from there when it makes the installer. For that we have process-images.bat.\n---\n## Embedded authors \u0026 keywords\n\nThe original collection of TIFF images (from the DVD) has a minority of images that had the English index items and (more importantly) the illustrator. For example,\n\n```\n$ exiftool Philippines/ELK-219.tif\n\u003csnip\u003e\nCreator                         : Dan Elkins\nSubject                         : hone, mengasah, pole, tiang\nKeywords                        : hone, mengasah, pole, tiang\n```\nNotice that these were done with both English and Indonesian keywords. The keywords are not really helpful at this point, as they are replaced by the index. But having the Creator embedded is terrific; it means that once we add the copyright and license, this image is self-contained in terms of giving proper attribution.\n\nBut again, this is just a minority of the images. A quick look suggests there might be more artists in our index than are already embedded in our source TIFF files. The upstream project, image-collection-starter, has a TODO to push artist credits from the index into images. If/when that lands in this fork, it would be good to have some kind of sanity check to make sure that reading authors from our index increases the number of images with author info embedded, and doesn't decrease it.\n\n---\n## History\nAOR started out as a DVD named \"International Illustrations: The Art of Reading\". It contained over 10k b\u0026w line drawings from SIL entities around the world.\n\nThe package came with a permissive license, but it was just in English prose. It came with a commercial catalogue viewer (I think Portfolio from Extensis), so it couldn't be given away (we had to pay for each copy).\n\nIn 2011, in consultation with the Global Publishing department of SIL (the copyright holder), Hatton did the following:\n\n* added a Creative Commons License, embedded in each image\n* embedded the index words into each image\n* converted to PNG and compressed\n* created a simple Windows installer\n* published for free on the bloomlibrary.org site as \"the Art of Reading\"\n\nIn 2014, McConnel make a Linux package for AOR.\n\nIn 2015, we used Google Translate API to add Arabic, French, Hindi, Portuguese,  Thai, Swahili, and Chinese index terms.\n\nIn October 2016, Arjen Lock and Michael Friedrich submitted Russian index items, and we released that as version 3.2.\n\nIn 2017, SIL International released Art Of Reading 3.3 with a change of license from CC-BY-ND to CC-BY-SA. We also started over with the build system by building [image-collection-starter](https://github.com/sillsdev/image-collection-starter) and then forking this repository off of that.\n","funding_links":[],"categories":["Software"],"sub_categories":["Utilities"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsillsdev%2FArtOfReading","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsillsdev%2FArtOfReading","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsillsdev%2FArtOfReading/lists"}