Skip to content

Commit 72fc3e8

Browse files
committed
docs: add installation guide
1 parent 1583a21 commit 72fc3e8

File tree

2 files changed

+73
-0
lines changed

2 files changed

+73
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Recaps
2+
3+
Service for calculating worked hours for a given period.
4+
5+
6+
## Table of Contents
7+
8+
- [Installation](#installation)
9+
- [Usage](#usage)
10+
11+
12+
## Installation
13+
14+
15+
### Clone the Repository
16+
```bash
17+
git clone <url>
18+
cd recaps
19+
```
20+
21+
### Make recaps directory
22+
```bash
23+
cp recaps.example recaps
24+
```
25+
26+
### Activate environment
27+
```bash
28+
python3 -m venv venv
29+
source venv/bin/activate
30+
```
31+
32+
### Download the packages
33+
```bash
34+
pip install -r requirements.txt
35+
```
36+
37+
38+
## Usage
39+
```bash
40+
python main.py example.yaml
41+
```
42+
43+
44+
## Final Notes
45+
46+
We hope you find this service helpful.
47+
48+
Thank you for using our service! 🚀

recaps.example/example.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
date:
2+
start: 2024-10-26
3+
end: 2024-10-31
4+
5+
expected:
6+
office_hours: 3
7+
remote_hours: 2
8+
9+
dailies:
10+
11+
26-10-24:
12+
office:
13+
- '08:20'
14+
- '11:00'
15+
remote:
16+
- '17:00'
17+
- '19:00'
18+
19+
27-10-24:
20+
remote:
21+
- '11:00' # 1-part
22+
- '13:30'
23+
- '18:30' # 2-part
24+
- '20:00'
25+

0 commit comments

Comments
 (0)