agaric/pomodoroprompt
10
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Start updating instructions for Nix OS, Agaric Forgejo

Browse source
This commit is contained in:
benjamin melançon 2024-11-13 14:06:59 -05:00
parent 8be4250b66
commit a570aa4e6d
1 changed files with 18 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -4,17 +4,32 @@
## Requirements
### Anything other than NixOS
* Python 3
* [pip](https://packaging.python.org/guides/installing-using-linux-tools/) for Python3
NOTE: Instructions are written with the assumption that the command `python` points to the python3 interpreter. If `python --version` reports a 2.x version, you should substitute `python3` in the commands using `python` below.
### NixOS
```
python
python311Packages.playsound
python311Packages.pycairo
python311Packages.pygobject3
python311Packages.pytz
python311Packages.tzlocal
```
(And skip the last two lines below, the pip install, as the above is the Nix way of doing that.)
## Installation
```
mkdir -p ~/Projects/agaric/python
git clone git@gitlab.com:agaric/python/pomodoroprompt.git
mkdir -p ~/Projects/agaric
cd ~/Projects/agaric/
git clone git@git.agaric.com:agaric/pomodoroprompt.git
cd pomodoroprompt
python -m pip install --user -r requirements.txt
```
@ -38,7 +53,7 @@ Create file ``~/.local/bin/pomodoroprompt` with contents:
# Helper to call our pomodoro script. We actually skip the & so we can end it
# with ctrl+c
python ~/Projects/agaric/python/pomodoroprompt/pomodoroprompt.py
python ~/Projects/agaric/pomodoroprompt/pomodoroprompt.py
```
Now you can start it with `pomodoroprompt` on the command line from any directory.