Update project docs and problem notes
This commit is contained in:
67
scripts/README.md
Normal file
67
scripts/README.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# MD Hub Secure - Development Scripts
|
||||
|
||||
This directory contains helper scripts for monitoring development progress.
|
||||
|
||||
## Scripts
|
||||
|
||||
### `install-monitor.sh`
|
||||
Installs and starts the progress monitor as a background process.
|
||||
|
||||
```bash
|
||||
./scripts/install-monitor.sh
|
||||
```
|
||||
|
||||
The monitor will:
|
||||
- Watch for filesystem changes every 10 minutes
|
||||
- Update `docs/STATUS.md` with current progress
|
||||
- Auto-exit if no changes detected for 10 minutes (Codex idle/finished)
|
||||
- Provide code review notes and action items
|
||||
|
||||
### `monitor.sh`
|
||||
The actual monitoring script. Usually called via `install-monitor.sh`.
|
||||
|
||||
```bash
|
||||
./scripts/monitor.sh
|
||||
```
|
||||
|
||||
Runs in foreground. Press Ctrl+C to stop.
|
||||
|
||||
### `status.sh`
|
||||
Quick status check without starting the monitor.
|
||||
|
||||
```bash
|
||||
./scripts/status.sh
|
||||
```
|
||||
|
||||
Shows:
|
||||
- Whether monitor is running
|
||||
- Current progress report from `docs/STATUS.md`
|
||||
|
||||
## Usage
|
||||
|
||||
1. Start monitoring (run once):
|
||||
```bash
|
||||
./scripts/install-monitor.sh
|
||||
```
|
||||
|
||||
2. Check status anytime:
|
||||
```bash
|
||||
./scripts/status.sh
|
||||
```
|
||||
|
||||
3. View live logs:
|
||||
```bash
|
||||
tail -f monitor.log
|
||||
```
|
||||
|
||||
4. Stop monitor:
|
||||
```bash
|
||||
kill $(cat .monitor.pid)
|
||||
```
|
||||
|
||||
## Files Generated
|
||||
|
||||
- `docs/STATUS.md` — Current project status and code review notes
|
||||
- `docs/.last_state_hash` — Internal file for tracking changes
|
||||
- `monitor.log` — Log output from monitor
|
||||
- `.monitor.pid` — Process ID of running monitor
|
||||
Reference in New Issue
Block a user