From 9da32dab4b02399452f2d1daf4b3dc3a5001faae Mon Sep 17 00:00:00 2001 From: C0UNTM31N Date: Sat, 10 Sep 2022 00:05:08 -0500 Subject: [PATCH] Altered the deploy script and added build instructions --- README.md | 27 +++++++++++++++++++++++++++ tools/buildAndClean.sh | 12 ++++++++++++ tools/deploy.sh | 5 +++-- 3 files changed, 42 insertions(+), 2 deletions(-) create mode 100755 tools/buildAndClean.sh diff --git a/README.md b/README.md index 09b340f4..89fb3443 100644 --- a/README.md +++ b/README.md @@ -30,12 +30,39 @@ Currently, these distributions have existing packages for HyFetch: * Nix: `nix-env -i hyfetch` (Thanks to @ YisuiDenghua) * Guix: `guix install hyfetch` (Thanks to @ WammKD) +### Method 3: Install using git and python + ## Usage When you run `hyfetch` for the first time, it will prompt you to choose a color system and a preset. Just follow the prompt, and everything should work (hopefully). If something doesn't work, feel free to submit an issue! If you want to use the updated `neofetch` without LGBTQ flags, check out [this section](https://github.com/hykilpikonna/hyfetch#running-updated-original-neofetch) +## Contributing + +### Build Dependencies: + +Ubuntu/Pop!_OS: + python-is-python3 + twine + +### Building Hyfetch + +clone the git repository using: + `git clone https://github.com/hykilpikonna/hyfetch.git` + +cd into the repository's directory + +cd into the "tools" directory + +run the following command: + `./buildAndClean.sh` + +### Running the build + +go into the root of the hyfetch directory and run the following command: + `python runner.py` + #### Q: How do I change my config? A: Use `hyfetch -c` diff --git a/tools/buildAndClean.sh b/tools/buildAndClean.sh new file mode 100755 index 00000000..313884df --- /dev/null +++ b/tools/buildAndClean.sh @@ -0,0 +1,12 @@ +#!/usr/bin/env bash + +# Stop on error +set -e + +# Remove old build +rm -rf ../dist/* +rm -rf ../build/* + +# Build +cd .. +python setup.py sdist bdist_wheel diff --git a/tools/deploy.sh b/tools/deploy.sh index d0f1a212..a4efc222 100755 --- a/tools/deploy.sh +++ b/tools/deploy.sh @@ -4,10 +4,11 @@ set -e # Remove old build -rm -rf dist/* -rm -rf build/* +rm -rf ../dist/* +rm -rf ../build/* # Build +cd .. python setup.py sdist bdist_wheel # Check built files