Skip to content
This repository was archived by the owner on Feb 7, 2025. It is now read-only.

Commit b74f093

Browse files
committed
modify README
1 parent 0eaacb6 commit b74f093

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ near-realtime picture of Earth.
2828
## Configuration
2929

3030
```
31-
usage: [-h] [--version] [--auto-offset | -o OFFSET] [-l {4,8,16,20}]
32-
[-d DEADLINE] [--save-battery] [--output-dir OUTPUT_DIR]
31+
usage: himawaripy [-h] [--version] [--auto-offset | -o OFFSET]
32+
[-l {4,8,16,20}] [-d DEADLINE] [--save-battery]
33+
[--output-dir OUTPUT_DIR] [--dont-change]
3334
3435
set (near-realtime) picture of Earth as your desktop background
3536
@@ -46,9 +47,11 @@ optional arguments:
4647
-d DEADLINE, --deadline DEADLINE
4748
deadline in minutes to download all the tiles, set 0
4849
to cancel
49-
--save-battery stop updating on battery
50+
--save-battery stop refreshing on battery
5051
--output-dir OUTPUT_DIR
5152
directory to save the temporary background image
53+
--dont-change don't change the wallpaper (just download it)
54+
5255
```
5356

5457
Most of the time himawaripy can accurately detect your timezone if you pass the flag `--auto-offset`, although you may
@@ -64,6 +67,9 @@ minutes before it is started again.
6467

6568
You might use `--save-battery` to disable refreshing while running on battery power.
6669

70+
You might also ask himawaripy to not to change your wallpaper by `--dont-change`
71+
if you would it to download the image and stop.
72+
6773
### Nitrogen
6874
If you use nitrogen for setting your wallpaper, you have to enter this in your
6975
`~/.config/nitrogen/bg-saved.cfg`.
@@ -79,13 +85,10 @@ bgcolor=#000000
7985
* You need a valid python3 installation including the python3-setuptools package
8086

8187
```
82-
cd ~
83-
git clone https://github.com/boramalper/himawaripy.git
88+
# Install
89+
pip install --user himawaripy
8490
85-
# install
86-
sudo python3 setup.py install
87-
88-
# test whether it's working
91+
# Test whether it's working
8992
himawaripy --auto-offset
9093
9194
# Get the installation path of himawaripy by running the command
@@ -102,7 +105,7 @@ which -- himawaripy
102105
## OR, alternatively use the provided systemd timer
103106
104107
### Configure
105-
vi systemd/himawaripy.service
108+
nano systemd/himawaripy.service
106109
# Replace "<INSTALLATION_PATH>" with the output of the aforementioned command and command line arguments
107110
108111
### Copy systemd configuration
@@ -160,20 +163,17 @@ Finally, to launch it, enter this into the console:
160163
## Uninstallation
161164

162165
```
163-
# Remove the cronjob
164-
crontab -e
165-
# Remove the line
166-
*/10 * * * * <INSTALLATION_PATH>
166+
# Either remove the cronjob
167+
crontab -e
168+
# Remove the line
169+
*/10 * * * * himawaripy...
167170
168171
# OR if you used the systemd timer
169172
systemctl --user disable --now himawaripy.timer
170173
rm $HOME/.config/systemd/user/himawaripy.{timer,service}
171174
172-
# Uninstall the binary
173-
sudo rm -f <INSTALLATION_PATH>
174-
175175
# Uninstall the package
176-
sudo pip3 uninstall himawaripy
176+
pip3 uninstall himawaripy
177177
```
178178

179179

systemd/himawaripy.service

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ Description=Update desktop background with satellite imagery
55

66
[Service]
77
Type=oneshot
8-
ExecStart=<INSTALLATION_PATH>
8+
ExecStart=<INSTALLATION_PATH> # command line arguments here

0 commit comments

Comments
 (0)