From a07a784f7a5ccad88a8f05455f75f5abe6fbe87e Mon Sep 17 00:00:00 2001 From: 0x1eef <0x1eef@protonmail.com> Date: Thu, 2 May 2024 08:04:35 -0300 Subject: [PATCH] Add bin/setup --- README.md | 21 +++++++++------------ bin/setup | 7 +++++++ 2 files changed, 16 insertions(+), 12 deletions(-) create mode 100755 bin/setup diff --git a/README.md b/README.md index 6bd21beaf..5d022c687 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,14 @@ After the website is built, the build directory consists of HTML, CSS, JavaScript and other static assets that can be hosted by a standard web server (eg nginx, apache, ...). -## Stack +## Environment -The following languages and tools have to be installed before -the website can be built: +The following languages and tools have to be installed to build +the website from source: -* Ruby 3.1, or later. -* NodeJS v18.15, or later. -* [tidy-html5](https://github.com/htacg/tidy-html5)
- There is a good chance there's a package available for - tidy-html5 on your operating system of choice. +* Ruby 3.1 (or later) +* NodeJS v18.15 (or later) +* [tidy-html5](https://github.com/htacg/tidy-html5) ## Development @@ -24,9 +22,8 @@ the website can be built: git clone https://github.com/ReflectsLight/al-quran.git cd al-quran - # Install Ruby, NodeJS packages - bundle install - npm i + # Setup build environment + bin/setup # Build website rake nanoc:build @@ -36,7 +33,7 @@ the website can be built: ## Thanks -First and foremost, Alhamdulillah. +Alhamdulillah. * Thanks to the following graphic artists: - [RefreshIcon](/src/js/components/Icon.tsx) diff --git a/bin/setup b/bin/setup new file mode 100755 index 000000000..dc7f9c0aa --- /dev/null +++ b/bin/setup @@ -0,0 +1,7 @@ +#!/bin/sh -ex + +## +# main +bundle install +npm i +git submodule update --init --recursive