-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Modify README.MD and add scripts/icons
- Loading branch information
Showing
3 changed files
with
116 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
type -p curl >/dev/null || (sudo apt update && sudo apt install curl -y) | ||
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \ | ||
&& sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \ | ||
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \ | ||
&& sudo apt update \ | ||
&& sudo apt install gh -y |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,110 @@ | ||
# Console-Weather-App | ||
# Console Weather App | | ||
![GitHub commit activity](https://img.shields.io/github/commit-activity/t/Degamisu/Console-Weather-App) ![GitHub commits since latest release](https://img.shields.io/github/commits-since/Degamisu/Console-Weather-App/latest) ![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/Degamisu/Console-Weather-App) | ||
--- | ||
|
||
|
||
![Alt text](CWA.png) | ||
|
||
## About | ||
|
||
This app is a console based weather app. You can choose between 2 options for location. You can **Specify** the location, or you can automatically find the location based off of **GPS tracking**. This is a very fast and reliable service that is being updated frequently. | ||
|
||
## Security | ||
|
||
Some people get a little worried when they hear "Tracking." This app does not take personal information/location and uploads it anywhere. Your location is contained in the console and only used to gather weather data. Your location is broad, therefore there will be no worries about leaked locations. If this is forked and not committed to the official repository, it may not be safe. Check the repositories code to see if it is safe. | ||
|
||
## Sources | ||
|
||
This app gets its weather data with: | ||
|
||
- Geocoder | ||
- [Open Metro API](https://api.open-meteo.com/v1/forecastP|) | ||
|
||
Making this app very fast and reliable. | ||
|
||
## Installation (with source) | ||
|
||
**Notes:** | ||
- This currently only works on Ubuntu Linux. This may change. | ||
- Git must be installed. Install it with [this](InstallGit.bash) | ||
|
||
<details> | ||
<summary>Download Source Code</summary> | ||
|
||
To install the source code, run this command in any terminal: | ||
|
||
```bash | ||
mkdir Console-Weather-App-Source && cd Console-Weather-App-Source && gh repo clone Degamisu/Console-Weather-App && cd Console-Weather-App | ||
``` | ||
This should download the source | ||
</details> | ||
<details> | ||
<summary>Install Dependencies</summary> | ||
This is the install command to install necissary dependencies. | ||
|
||
```bash | ||
pip install -r requirements.txt | ||
``` | ||
|
||
**THIS IS CRUCIAL** to the installation of CWA. | ||
</details> | ||
|
||
--- | ||
**The next part can be done in 2 ways** | ||
|
||
<details> | ||
<summary>Build the executable</summary> | ||
|
||
__This requires `pyinstaller` to build, which is installed under the `Install Dependencies` dropdown__ | ||
|
||
--- | ||
|
||
To build, run this into your bash console | ||
```bash | ||
$ pyinstaller --onefile main.py | ||
$ ./main | ||
``` | ||
|
||
</details> | ||
<details> | ||
<summary>Run directly</summary> | ||
This is the easiest way through, skipping the building part. However, it would be harder to transport. | ||
|
||
|
||
--- | ||
|
||
**Python** | ||
```bash | ||
$ python ./main.py | ||
``` | ||
|
||
**Python3** | ||
```bash | ||
$ python3 ./main.py | ||
``` | ||
|
||
</details> | ||
|
||
--- | ||
|
||
This section is optional. | ||
|
||
<details> | ||
<summary>Cleanup</summary> | ||
|
||
To clean up build artifacts (under /build), run this script: | ||
|
||
```bash | ||
$ rm -r build | ||
``` | ||
</details> | ||
|
||
--- | ||
|
||
## Contributing | ||
|
||
Have an idea for CWA? Contributing will be open soon. For now, you can open issues! | ||
|
||
--- | ||
|
||
© 2024 Degamisu | All Rights Reserved | [README](README.md) Created by **Emi Yamashita** |