From fbec5ca04a065570bcc9f126669235fb8140b14e Mon Sep 17 00:00:00 2001 From: Vishnu KS Date: Mon, 12 Oct 2020 13:00:07 +0530 Subject: [PATCH] Move when to run script to top. --- utils/README.MD | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/utils/README.MD b/utils/README.MD index ab66466..1e09eab 100644 --- a/utils/README.MD +++ b/utils/README.MD @@ -1,5 +1,9 @@ `utils/` mainly contains scripts for generating `app/src/data/books.json` file from `README.md` +In most cases, you don't want to run the scripts in this directory or make changes to it. +The only time you want to mess with the scripts is when you want to fetch some extra data from `API` or +want to update the `app/src/data/books.json` file to include a newly added book or category. + ## Generating `app/src/data/books.json` The website shows name of the book, year, rating, cover, amazon link, etc in book card. Some of the @@ -12,10 +16,6 @@ The script goes through all the books in [main README.md](../README.md) and star from `Goodreads` and `Google Search` API. And the result is stored in `utils/books.json` and `utils/book_name_to_details.json` (used for caching only). -Once the script completes the run, the `utils/books.json` file is copied to `app/src/data/books.json` manually. +Once the script completes the run, the `utils/books.json` file is copied to `app/src/data/books.json` **manually**. And the website uses the data from `app/src/data/books.json` for generating the pages. - -In most cases, you don't want to run the `utils/update_json_files.py` or make changes to it while working on the website. -The only time you want to mess with the script is when you want to fetch some extra data from `API` or want to update -the `book.json` file to include a newly added book or category.