Skip to content

Commit 45f3acb

Browse files
committed
docs: add README and MIT license
1 parent 17434fd commit 45f3acb

2 files changed

Lines changed: 63 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 RandomCodeSpace
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# VIGIL
2+
3+
Personal task command center for Windows. Single-file PowerShell + WPF app with
4+
a chromeless Fluent window, Outlook sync, and a system tray icon.
5+
6+
## Features
7+
8+
- Chromeless WPF window with Fluent theme and Mica backdrop (Windows 11)
9+
- Tabs for Tasks and Calendar, always-on-top toggle, compact mode
10+
- Outlook sync: 24h calendar items, flagged emails, and open Outlook tasks
11+
- Clickable top-bar badges (CAL / TASK / CRIT / HIGH) as filters
12+
- DPAPI-encrypted local storage in `.vigil/` next to the script
13+
- System tray icon with quick actions
14+
- Desktop shortcut auto-installed on first run
15+
- 116 cross-platform unit tests for the data layer
16+
17+
## Requirements
18+
19+
- Windows 10/11
20+
- PowerShell 7.5+ (`pwsh`) with .NET 9
21+
- Microsoft Outlook (only for sync)
22+
23+
## Run
24+
25+
```powershell
26+
pwsh -ExecutionPolicy Bypass -File .\VIGIL.ps1
27+
```
28+
29+
First launch creates `.vigil/` alongside `VIGIL.ps1`, installs a Desktop
30+
shortcut, and registers an auto-start entry.
31+
32+
## Tests
33+
34+
```powershell
35+
pwsh -NoProfile -File .\Test-Vigil.ps1
36+
```
37+
38+
Tests run cross-platform (Linux / macOS pwsh) against the `-NoUI` data layer.
39+
40+
## License
41+
42+
[MIT](LICENSE)

0 commit comments

Comments
 (0)