Added build instructions in README.md#21
Conversation
|
Also sorry for the number of commits, had trouble formatting the markdown file. |
|
Thank you for the pull request! I'll review it shortly |
README.md
Outdated
| ```sh | ||
| git clone https://github.com/hykilpikonna/hyfetch.git | ||
| cd hyfetch | ||
| sudo python setup.py install |
There was a problem hiding this comment.
Using setup.py install is not recommended because it cannot be uninstalled easily. Should use pip install . instead.
https://stackoverflow.com/questions/1550226/python-setup-py-uninstall
| rm -rf dist/* | ||
| rm -rf build/* | ||
| rm -rf ../dist/* | ||
| rm -rf ../build/* | ||
|
|
||
| # Build | ||
| cd .. |
There was a problem hiding this comment.
I'm sorry that I haven't clarified how to use the scripts in the tools directory.
When I wrote the deploy script, I didn't intend for it to be run in the tools directory. The original paths work if you run ./tools/deploy.sh in the root directory for this repo. This applies to all other scripts in tools as well
README.md
Outdated
| go into the root of the hyfetch directory and run the following command: | ||
| `python runner.py` |
There was a problem hiding this comment.
Actually I wrote runner.py before I knew that modules can be executed with python -m {module}. So now you can run hyfetch from source by running python -m hyfetch from project root without building or using runner.py.
I can delete runner.py afterwards
Prompt for preset selection
2 participants
Description
Added instructions to build the program and copied the deploy.sh script with the twine commands removed.
Only fill in the fields below if relevant.
Features
Issues
TODO