emma/Wallman
emma/Wallman
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity

Adjust documentation for newly packaged version.

Browse source
This commit is contained in:
Emma Nora Theuer 2024-06-03 22:30:03 +02:00
parent 8b78d56040
commit e000110958
1 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.org
View file

@ -20,10 +20,21 @@ Wallman currently has three main features:
+ APScheduler (Install python-apscheduler or APScheduler, depending on the package manager) + APScheduler (Install python-apscheduler or APScheduler, depending on the package manager)
+ feh (Used for setting the wallpapers, hard dependency) + feh (Used for setting the wallpapers, hard dependency)
*** Optional *** Optional
+ libnotify (for desktop notification support.) + libnotify (for desktop notification support)
*** Build dependencies
+ setuptools
+ build
** Installing with pip
Wallman is available on PYPI. Simply run:
#+BEGIN_SRC shell
pip install wallman
#+END_SRC
** How to install it? ** Installing with package Manager
Versions in the AUR and an ebuild for Gentoo will be added soon. A flatpak and Nixpkgs version are on the horizon, too.
** Installing manually
+ Clone this git repo + Clone this git repo
+ Create a log file and a configuration file: + Create a log file and a configuration file:
#+BEGIN_SRC shell #+BEGIN_SRC shell
@ -64,8 +75,6 @@ The keys in the dictionary once again do not matter, the names of the keys in ea
* TODOs * TODOs
** Structuring ** Structuring
+ Write unittests + Write unittests
+ Write a setup.py
+ Improve the general directory layout
+ Add documentation for developers + Add documentation for developers
** Technical Details ** Technical Details