diff --git a/README.md b/README.md index 09b340f4..ebc02799 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ This repo also serves as an updated version of the original `neofetch` since the * Method 2: `npx neowofetch` * Method 3: `bash <(curl -sL neowofetch.hydev.org)` + ## Installation ### Method 1: Install using Python pip (Recommended) @@ -26,9 +27,20 @@ pip install hyfetch Currently, these distributions have existing packages for HyFetch: -* ArchLinux: `yay -S hyfetch` (Thanks to @ Aleksana) -* Nix: `nix-env -i hyfetch` (Thanks to @ YisuiDenghua) -* Guix: `guix install hyfetch` (Thanks to @ WammKD) +* ArchLinux: `yay -S hyfetch` (Thanks to [@Aleksana](https://github.com/Aleksanaa)) +* Nix: `nix-env -i hyfetch` (Thanks to [@YisuiDenghua](https://github.com/YisuiDenghua)) +* Guix: `guix install hyfetch` (Thanks to [@WammKD](https://github.com/WammKD)) + +### Method 3: Install the latest developmental version using git + +Install Python >= 3.7 first. Then run the following commands: + +```sh +git clone https://github.com/hykilpikonna/hyfetch.git +cd hyfetch +pip install . +``` + ## Usage @@ -36,6 +48,9 @@ When you run `hyfetch` for the first time, it will prompt you to choose a color If you want to use the updated `neofetch` without LGBTQ flags, check out [this section](https://github.com/hykilpikonna/hyfetch#running-updated-original-neofetch) + +## Questions and answers + #### Q: How do I change my config? A: Use `hyfetch -c` @@ -48,6 +63,18 @@ Feel free to experiment with it! ![image](https://user-images.githubusercontent.com/22280294/162614553-eb758e4e-1936-472c-8ca7-b601c696c6eb.png) + +## Contributing + +To make changes to our codebase, you first need to create a fork by clicking the "Fork" button on the top right. Then, you can clone your fork of the source code using `git clone https://github.com/{your username}/hyfetch.git`. + +After making changes to the source code, you can run `python -m hyfetch` in the root directory of your repo to test out your changes. + +If they work correctly, you can commit and push these changes using git command or Github Desktop. Then, you can create a pull request on Github so that it can go into our next release! + +You can also install your version locally by running `pip install .` in the repo root. + + ## Change Log ### About Notation 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