Altered the deploy script and added build instructions
This commit is contained in:
parent
58a82c2b5e
commit
9da32dab4b
3 changed files with 42 additions and 2 deletions
27
README.md
27
README.md
|
@ -30,12 +30,39 @@ Currently, these distributions have existing packages for HyFetch:
|
||||||
* Nix: `nix-env -i hyfetch` (Thanks to @ YisuiDenghua)
|
* Nix: `nix-env -i hyfetch` (Thanks to @ YisuiDenghua)
|
||||||
* Guix: `guix install hyfetch` (Thanks to @ WammKD)
|
* Guix: `guix install hyfetch` (Thanks to @ WammKD)
|
||||||
|
|
||||||
|
### Method 3: Install using git and python
|
||||||
|
|
||||||
## Usage
|
## 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!
|
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)
|
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?
|
#### Q: How do I change my config?
|
||||||
|
|
||||||
A: Use `hyfetch -c`
|
A: Use `hyfetch -c`
|
||||||
|
|
12
tools/buildAndClean.sh
Executable file
12
tools/buildAndClean.sh
Executable file
|
@ -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
|
|
@ -4,10 +4,11 @@
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
# Remove old build
|
# Remove old build
|
||||||
rm -rf dist/*
|
rm -rf ../dist/*
|
||||||
rm -rf build/*
|
rm -rf ../build/*
|
||||||
|
|
||||||
# Build
|
# Build
|
||||||
|
cd ..
|
||||||
python setup.py sdist bdist_wheel
|
python setup.py sdist bdist_wheel
|
||||||
|
|
||||||
# Check built files
|
# Check built files
|
||||||
|
|
Loading…
Reference in a new issue