Storm Dragon
31 lines
1.1 KiB
Markdown
31 lines
1.1 KiB
Markdown
# TTYverse Agent Guide
|
|
|
|
## Project Layout
|
|
- `ttyverse.pl` is the main (large) Perl script and source of truth.
|
|
- `ttytter.pl` is the original upstream script for reference.
|
|
- `extensions/` contains optional extensions.
|
|
- `ttyverse.wiki/` contains user and developer documentation.
|
|
|
|
## Run
|
|
- `./ttyverse.pl`
|
|
- `perl ttyverse.pl`
|
|
- `./ttyverse.pl -version`
|
|
|
|
## Testing
|
|
- No automated test suite is present.
|
|
- Minimum sanity check after edits: `perl -c ttyverse.pl`.
|
|
- Manual checks are expected (login, timelines, posting, notifications, media, polls).
|
|
|
|
## Coding Standards
|
|
- Follow the existing code style in `ttyverse.pl`.
|
|
- New code should use camelCase variables, snake_case functions/methods, and PascalCase class names.
|
|
- For bash scripts, all variables must be camelCase (except system env vars). Run `shellcheck` on any edited bash script and fix issues.
|
|
- Log lines should be `message [timestamp]` (message first).
|
|
|
|
## Accessibility
|
|
- Do not use Speech-Dispatcher or `spd-say` in GUI contexts.
|
|
- Prefer clear, complete labels and avoid keyboard traps.
|
|
|
|
## System Interactions
|
|
- If a task requires `sudo`, ask the user to run it.
|