From abefc10eedc1f71d791ea86394fd749a3d8b5e0d Mon Sep 17 00:00:00 2001 From: Waishnav Date: Tue, 11 Oct 2022 03:44:14 +0530 Subject: cleaning documentation stuffs | making it pure dev-branch for v2.0 --- README.md | 40 ---------------------------------------- 1 file changed, 40 deletions(-) delete mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md deleted file mode 100644 index 353c5a3..0000000 --- a/README.md +++ /dev/null @@ -1,40 +0,0 @@ -# Watcher -### Minimal Open source Screen-Time Tracker (CLI-app) - - -## Table of Contents - -- [About](#about) -- [Gallery](#gallery) -- [Installation](#installation) -- [Todo](#to-do) - -## About -Watcher is CLI-app (at this moment) which helps you to get perspective about your Screen-time - -## Gallery -Day Summary | Week Summary -:-------------------------:|:-------------------------: -![](https://cdn.discordapp.com/attachments/846673042893832195/952283314746691624/unknown.png) | ![](https://cdn.discordapp.com/attachments/846673042893832195/952283190716948521/unknown.png) - -Funfact: You might be thinking how can someone has 14 hrs of screen time in a single day, Well ! short ans is AFK-feature is not implemented yet... Most of the time I left my laptop as it is so it also counts that AFK time as Screen-time - -## Installation -* Note: Install [```xprintidle```](https://github.com/g0hl1n/xprintidle) and [```xdotool```](https://github.com/jordansissel/xdotool) on your system ( its the only dependancy ) -* First, Install the following dependancy ```xprintidle``` and ```xdotool``` -```bash -$ sudo [package-manager] install xprintidle xdotool -``` -* Second, Clone this repository and cd into it- -```bash -$ git clone https://github.com/Waishnav/Watcher -$ cd ./Watcher/ -``` -* Then run install script -```bash -$ chmod +x ./install && ./install -``` - -## To-do -- [x] AFK feature -- [ ] GUI only if got 300 stars Probably [Tauri App](https://github.com/tauri-apps/tauri). -- cgit v1.2.3