diff --git a/README.md b/README.md index a49ee4f..ead8ef6 100644 --- a/README.md +++ b/README.md @@ -27,25 +27,33 @@ Feel free to play with the web demo above! ## 🚀 Ship your LiveTerm site in less than 5 minutes -First, clone this repository: +LiveTerm requires the `yarn` package manager. You can install `yarn` [here](https://classic.yarnpkg.com/lang/en/docs/install/). + +Simply run the following commmand in your terminal: ```bash -git clone https://github.com/Cveinnt/LiveTerm.git +sh -c "$(curl -fsSL https://raw.github.com/Cveinnt/LiveTerm/main/install/install.sh)" ``` -Then, install dependencies: +This will install LiveTerm to the current directory. You can start building your website with: ```bash -yarn install +cd LiveTerm && yarn dev ``` -Now you can start developing! +Start editing `config.json` and try saving and see the updated changes! + +Alternatively, you can clone this repository to a location of your choosing ```bash -yarn dev +git clone https://github.com/Cveinnt/LiveTerm.git && cd LiveTerm ``` -Start editing `config.json` and try saving and see the updated changes! +Then install dependencies and start developing there: + +```bash +yarn install && yarn dev +``` ## 📄 Configuration diff --git a/install/install.sh b/install/install.sh new file mode 100644 index 0000000..d04e1e1 --- /dev/null +++ b/install/install.sh @@ -0,0 +1,59 @@ +#!/bin/sh +# This script installs LiveTerm. +# +# Found a bug? Report it here: https://github.com/Cveinnt/LiveTerm/issues + +set -e -u + +eval "git clone 'https://github.com/Cveinnt/LiveTerm.git'" + +cd LiveTerm + +echo "LiveTerm cloned! Installing dependencies..." + +if command -v yarn >/dev/null 2>&1 ; then + yarn install +else + cat 1>&2 << 'EOA' +/=====================================\\ +| COMMAND NOT FOUND: 'yarn' | +\\=====================================/ + +Uh oh! We couldn't find 'yarn' installed on your system. + +You should first install 'yarn' on your system. + +For more information, visit yarn's installation page: + + https://classic.yarnpkg.com/lang/en/docs/install/ + +EOA + exit 1 +fi + +cat <<-'EOM' + + + █████ ███ ███████████ +░░███ ░░░ ░█░░░███░░░█ + ░███ ████ █████ █████ ██████ ░ ░███ ░ ██████ ████████ █████████████ + ░███ ░░███ ░░███ ░░███ ███░░███ ░███ ███░░███░░███░░███░░███░░███░░███ + ░███ ░███ ░███ ░███ ░███████ ░███ ░███████ ░███ ░░░ ░███ ░███ ░███ + ░███ █ ░███ ░░███ ███ ░███░░░ ░███ ░███░░░ ░███ ░███ ░███ ░███ + ███████████ █████ ░░█████ ░░██████ █████ ░░██████ █████ █████░███ █████ +░░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░░ ░░░░░ ░░░░░░ ░░░░░ ░░░░░ ░░░ ░░░░░ + + +LiveTerm has been downloaded to the current directory. +You can start developing it with: + +cd LiveTerm && yarn dev + +This will open a local port at http://localhost:3000, +where you can preview your website. To apply changes, edit: + +config.json + +And the changes should be applied upon saves! + +EOM \ No newline at end of file