storm/ttyverse
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor updates to some pages.

Storm Dragon
2025-07-29 15:00:35 -04:00
parent 50839c5880
commit 2335e82b3d
6 changed files with 23 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Commands-Reference.md

@ -63,7 +63,7 @@ Upload media (image, audio, video) with optional post text.
**Usage:** **Usage:**
```bash ```bash
/media /path/to/image.jpg # Upload image only /media /path/to/image.jpg # Upload image only
/media /path/to/audio.mp3 Great song! # Upload with message /media /path/to/audio.mp3
``` ```
**Accessibility:** Images require alt-text descriptions. TTYverse will prompt for alt-text and cancel uploads without descriptions. **Accessibility:** Images require alt-text descriptions. TTYverse will prompt for alt-text and cancel uploads without descriptions.
@ -157,7 +157,7 @@ Follow a user.
**Usage:** **Usage:**
```bash ```bash
/follow storm@stormux.org /follow @stormux@social.stormux.org
/follow @localuser /follow @localuser
``` ```
@ -260,7 +260,7 @@ When posting, content visibility is shown:
Some commands have shorter aliases: Some commands have shorter aliases:
- `/fav` = `/favorite` - `/fav` = `/favorite`
- `/boost` = `/rt` = `/reblog` - `/boost` = `/reblog`
- `/dms` = `/dm` - `/dms` = `/dm`
- `/quit` = `/exit` = `/q` - `/quit` = `/exit` = `/q`
@ -283,5 +283,3 @@ Common error messages:
--- ---
**See also:** [Getting Started](Getting-Started) | [Basic Usage](Basic-Usage) | [Advanced Features](Advanced-Features) **See also:** [Getting Started](Getting-Started) | [Basic Usage](Basic-Usage) | [Advanced Features](Advanced-Features)
*Last updated: 2025-07-28*

2
Extension-Development.md

@ -572,5 +572,3 @@ See existing extensions in `~/.local/share/ttyverse/extensions/` for examples.
--- ---
**See also:** [Extensions](Extensions) | [Configuration](Configuration) | [Commands Reference](Commands-Reference) **See also:** [Extensions](Extensions) | [Configuration](Configuration) | [Commands Reference](Commands-Reference)
*Last updated: 2025-07-29*

4
Extensions.md

@ -4,7 +4,7 @@ TTYverse supports extensions that add functionality like sound notifications, te
## Available Extensions ## Available Extensions
TTYverse includes several built-in extensions: TTYverse includes several optional extensions in the ttyverse-extensions submodule:
### Sound Pack Extension ### Sound Pack Extension
- **Purpose**: Audio notifications for different types of posts and events - **Purpose**: Audio notifications for different types of posts and events
@ -173,5 +173,3 @@ Want to create your own extensions? See the [Extension Development](Extension-De
--- ---
**See also:** [Extension Development](Extension-Development) | [Configuration](Configuration) | [Troubleshooting](Troubleshooting) **See also:** [Extension Development](Extension-Development) | [Configuration](Configuration) | [Troubleshooting](Troubleshooting)
*Last updated: 2025-07-29*

16
FAQ.md

@ -11,7 +11,6 @@ TTYverse is a command-line client for the fediverse (Mastodon, GoToSocial, etc.)
- **Accessibility-first design** - Built by and for screen reader users - **Accessibility-first design** - Built by and for screen reader users
- **Terminal-native** - No GUI dependencies, works over SSH - **Terminal-native** - No GUI dependencies, works over SSH
- **Single-file architecture** - Just one Perl script - **Single-file architecture** - Just one Perl script
- **Sound notifications** - Audio feedback for different post types
- **Enforced alt-text** - Images require descriptions for accessibility - **Enforced alt-text** - Images require descriptions for accessibility
### What servers does TTYverse support? ### What servers does TTYverse support?
@ -51,7 +50,7 @@ chmod +x ttyverse.pl
Use `/again` to load more posts from your timeline, or `/last 20` to see the last 20 cached posts. Use `/again` to load more posts from your timeline, or `/last 20` to see the last 20 cached posts.
### Can I use TTYverse over SSH? ### Can I use TTYverse over SSH?
Yes! TTYverse works perfectly over SSH connections. Sound notifications won't work over SSH, but all other features do. Yes! TTYverse works perfectly over SSH connections.
### How do I open links from posts? ### How do I open links from posts?
Use `/url <post_code>` (e.g., `/url a3`). TTYverse will automatically detect your environment and use appropriate browsers. Use `/url <post_code>` (e.g., `/url a3`). TTYverse will automatically detect your environment and use appropriate browsers.
@ -60,7 +59,7 @@ Use `/url <post_code>` (e.g., `/url a3`). TTYverse will automatically detect you
TTYverse enforces accessibility standards. The maintainer is blind, and the philosophy is: "If you're going to use a client maintained by a blind guy, you can damn well describe your images!" TTYverse enforces accessibility standards. The maintainer is blind, and the philosophy is: "If you're going to use a client maintained by a blind guy, you can damn well describe your images!"
### Can I post without media upload? ### Can I post without media upload?
Yes, use `/post Your message here` for text-only posts. Yes, just type something and press enter and it will be posted. If you have problems with fat fingering or typing things in the wrong window, use /set verify 1 or -verify. This can be added to the rc file to be default if desired.
## Technical Questions ## Technical Questions
@ -116,7 +115,7 @@ Use `/search` for:
### What accessibility features does TTYverse have? ### What accessibility features does TTYverse have?
- **Screen reader friendly** - All output is text-based - **Screen reader friendly** - All output is text-based
- **Sound notifications** - Audio feedback for events - **Sound notifications** - Audio feedback for events (requires sound.pl extension)
- **Alt-text enforcement** - Images must have descriptions - **Alt-text enforcement** - Images must have descriptions
- **Keyboard navigation** - No mouse required - **Keyboard navigation** - No mouse required
- **Terminal compatibility** - Works with any terminal - **Terminal compatibility** - Works with any terminal
@ -148,6 +147,7 @@ Yes, TTYverse includes several extensions:
- **soundpack.pl** - Sound notifications - **soundpack.pl** - Sound notifications
- **tts.pl** - Text-to-speech - **tts.pl** - Text-to-speech
- **libnotify.pl** - Desktop notifications - **libnotify.pl** - Desktop notifications
- **More to come** - Check the extensions directory or the repository: <https://git.stormux.org/storm/ttyverse-extensions>
## Troubleshooting ## Troubleshooting
@ -179,8 +179,8 @@ Yes, TTYverse includes several extensions:
### Can I contribute to TTYverse? ### Can I contribute to TTYverse?
Yes! Contributions are welcome: Yes! Contributions are welcome:
- Report bugs at https://git.stormux.org/storm/ttyverse/issues - Report bugs by mentioning @stormux@social.stormux.org
- Submit patches via email or git - Submit patches via git-email
- Improve documentation - Improve documentation
- Create extensions - Create extensions
@ -216,7 +216,7 @@ OAuth tokens must be saved for TTYverse to function. Tokens are stored with rest
- **Community:** Fediverse community support - **Community:** Fediverse community support
### How do I report bugs? ### How do I report bugs?
Report bugs at https://git.stormux.org/storm/ttyverse/issues with: Report bugs by DM or mention @stormux@social.stormux.org with:
- TTYverse version - TTYverse version
- System information - System information
- Steps to reproduce - Steps to reproduce
@ -226,5 +226,3 @@ Report bugs at https://git.stormux.org/storm/ttyverse/issues with:
--- ---
**See also:** [Getting Started](Getting-Started) | [Troubleshooting](Troubleshooting) | [Commands Reference](Commands-Reference) **See also:** [Getting Started](Getting-Started) | [Troubleshooting](Troubleshooting) | [Commands Reference](Commands-Reference)
*Last updated: 2025-07-28*

16
Installation.md

@ -37,14 +37,16 @@ chmod +x ttyverse.pl
### Method 2: Git Clone ### Method 2: Git Clone
```bash ```bash
# Clone repository # Clone repository with extensions
git clone https://git.stormux.org/storm/ttyverse.git git clone --recurse-submodules https://git.stormux.org/storm/ttyverse.git
cd ttyverse cd ttyverse
# Run TTYverse # Run TTYverse
perl ttyverse.pl perl ttyverse.pl
``` ```
**Note:** The `--recurse-submodules` flag ensures that TTYverse extensions are downloaded along with the main application.
### Method 3: System Package (Future) ### Method 3: System Package (Future)
*System packages are planned for future releases* *System packages are planned for future releases*
@ -262,10 +264,13 @@ curl https://mastodon.social/api/v1/instance
### For Contributors ### For Contributors
```bash ```bash
# Clone development repository # Clone development repository with extensions
git clone https://git.stormux.org/storm/ttyverse.git git clone --recurse-submodules https://git.stormux.org/storm/ttyverse.git
cd ttyverse cd ttyverse
# If you forgot --recurse-submodules, initialize submodules manually:
# git submodule update --init --recursive
# Install development dependencies # Install development dependencies
# (Add any dev-specific requirements here) # (Add any dev-specific requirements here)
@ -327,9 +332,10 @@ chmod +x ttyverse.pl
### Git Update ### Git Update
```bash ```bash
# If installed via git # If installed via git, update main repo and extensions
cd ttyverse cd ttyverse
git pull origin master git pull origin master
git submodule update --remote --recursive
``` ```
### Version Check ### Version Check

4
Quick-Commands.md

@ -14,7 +14,7 @@ Essential TTYverse commands for quick reference. For complete documentation, see
### Posting and Interaction ### Posting and Interaction
```bash ```bash
/post Hello world! # Create a public post Hello world! # Create a public post
/reply a3 Great point! # Reply to post a3 /reply a3 Great point! # Reply to post a3
/boost a3 # Boost post a3 /boost a3 # Boost post a3
/fav a3 # Favorite post a3 /fav a3 # Favorite post a3
@ -148,5 +148,3 @@ Posts show their visibility level:
--- ---
**See also:** [Commands Reference](Commands-Reference) | [Getting Started](Getting-Started) | [Basic Usage](Basic-Usage) **See also:** [Commands Reference](Commands-Reference) | [Getting Started](Getting-Started) | [Basic Usage](Basic-Usage)
*Last updated: 2025-07-28*