updated README
This commit is contained in:
25
README.md
25
README.md
@@ -6,6 +6,8 @@ This version of wfetch is semi-backwards compatible (config.toml will work! But
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
Fist download the latest release fron the releases page and extract it. Inside of the folder, you will see an executible named "wf-tool".
|
Fist download the latest release fron the releases page and extract it. Inside of the folder, you will see an executible named "wf-tool".
|
||||||
This will be the program that you will use to install and setup wfetch.
|
This will be the program that you will use to install and setup wfetch.
|
||||||
|
|
||||||
@@ -15,6 +17,28 @@ Open your favorite terminal in the folder and run `sudo ./wf-tool -i` This will
|
|||||||
Wfetch should quickly install. After wfetch is installed, run `./wf-tool -s` and follow the setup instructions
|
Wfetch should quickly install. After wfetch is installed, run `./wf-tool -s` and follow the setup instructions
|
||||||
> **WARNING**: Do not run this command under sudo. It will not let you run the setup if you do so.
|
> **WARNING**: Do not run this command under sudo. It will not let you run the setup if you do so.
|
||||||
|
|
||||||
|
### Windows
|
||||||
|
|
||||||
|
At this time Windows dows not have a build.
|
||||||
|
|
||||||
|
### MacOS
|
||||||
|
|
||||||
|
At this time MacOS does not have a build.
|
||||||
|
|
||||||
|
## Compiling
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
- Crystal compiler
|
||||||
|
- Wfetch Source Code
|
||||||
|
- wfetch-1.0.0-data.tar.xz
|
||||||
|
|
||||||
|
Download the latest release's source code and open your terminal inside the directory and run `shards build --release` and the build will be outputted in bin/
|
||||||
|
|
||||||
|
To actually install and setup your wfetch build, you will need to have a data directory with wftech and the disp configs.
|
||||||
|
|
||||||
|
Extract the data directory file and copy it to where your wfetch and wf-tool executable are. Once your data directory is copied/moved over, move wfetch inside of the data directory and then follow the installing instructions.
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
### How do I get an Weather API key?
|
### How do I get an Weather API key?
|
||||||
@@ -25,7 +49,6 @@ First, go to the [Weather API](https://www.weatherapi.com/) website and then sig
|
|||||||
|
|
||||||
Giving out an api key is one of the top ten things to never do in your life.
|
Giving out an api key is one of the top ten things to never do in your life.
|
||||||
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
1. Fork it (<https://github.com/koffeejava/wfetch/fork>)
|
1. Fork it (<https://github.com/koffeejava/wfetch/fork>)
|
||||||
|
|||||||
Reference in New Issue
Block a user