Remove duplicate plain-text README and consolidate documentation

This commit is contained in:
StasonJatham committed 2026-10-05 06:55:50 +02:00
1 parent 8c3a90225f
commit 7ee77c3fc2
4 files changed
+17 -185

No files matched your search

+16 -2
View File
@@ -129,7 +129,7 @@ repository. Examples under [examples/](examples/) use synthetic data.
- Exit `2`: an error or incomplete processing; inspect `SUMMARY.txt` and
`details/summary.json`. If the scan failed before presentation, inspect
`summary.json` at the result root instead.
- Missing years/timezones are not guessed. See [README.txt](README.txt) for time configuration.
- Missing years/timezones are not guessed. See time configuration below.
- Binary appliance logs may need an external decoder. Decode failures can also come from ordinary text.
- Damaged inputs and regex timeouts are reported. Archive path traversal, unsafe links and exhausted quotas stop preparation.
- Processing uses one worker, incremental reads and disk-backed SQLite. There is no hard process-wide RAM/CPU quota or automatic resume.
@@ -138,6 +138,20 @@ repository. Examples under [examples/](examples/) use synthetic data.
Tests were executed on macOS/ARM64. Windows and Linux instructions are provided,
but those platforms have not yet been validated in the recorded test environment.
## Time configuration
Use known device settings when logs omit their year or timezone:
```sh
netscaler-triage scan --input ADC-A=./logs --year 2026 --timezone ADC-A=UTC
```
The appliance name, year and timezone above are examples. Explicit timestamps
are retained; ambiguous daylight-saving times remain unresolved. Use
`--time-config` for per-device settings and per-file year overrides; see
[examples/time.json](examples/time.json). The effective assumptions are recorded
in `details/configuration.json`.
## Help and development
```sh
@@ -154,7 +168,7 @@ uv run ruff format --check src tests typing_stubs
uv build
```
See [README.txt](README.txt) for the detailed plain-text manual and
See [RULES.txt](RULES.txt) for rule-pack semantics and
[VALIDATION.txt](VALIDATION.txt) for test scope and known coverage limits.
## License