about summary refs log tree commit diff
diff options
context:
space:
mode:
authorManuel Palenzuela <manuelpalenzuelamerino@gmail.com>2019-06-30 12:47:40 +0200
committerManuel Palenzuela <manuelpalenzuelamerino@gmail.com>2019-06-30 12:47:40 +0200
commit9909196fa89f158c5d01c83bae3176c6b62f8622 (patch)
treef9f76a632953d71fa59476849479646b0312efb9
parentRemoved debugging echoes (diff)
downloadsmart-wallpaper-9909196fa89f158c5d01c83bae3176c6b62f8622.tar.gz
smart-wallpaper-9909196fa89f158c5d01c83bae3176c6b62f8622.tar.bz2
smart-wallpaper-9909196fa89f158c5d01c83bae3176c6b62f8622.zip
Added readme file
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ead3d9b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# Smart-Wallpaper
+
+A simple bash script that automatically changes your wallpaper depending on if its daytime or nighttime (helps your eyes).
+
+## Getting Started
+
+You can either clone the repository and run the script or if you are running Arch or derivatives get it from the AUR (https://aur.archlinux.org/packages/smart-wallpaper-git/).
+
+### Dependencies
+
+Required: redshift - determining if its day/night in your location.
+          feh - setting the wallpaper.
+          bash
+
+Optional: gifsicle - animated wallpaper support
+
+### Usage
+
+A step by step series of examples that tell you how to get a development env running
+
+Say what the step will be
+
+```
+Give the example
+```
+
+And repeat
+
+```
+until finished
+```
+
+End with an example of getting some data out of the system or using it for a little demo
+
+## Contributing
+
+Feel free to submit pull requests to clean up the code/adding new features. Thank you!
+
+
+## Author
+
+* **Baitinq** - *Whole script* - (https://github.com/Baitinq)
+
+See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the GPL License.
+
+## Acknowledgments
+
+* Stackoverflow me like