m1ngsama/TNT
1
0
Fork 0
mirror of https://github.com/m1ngsama/TNT.git synced 2026-02-08 00:54:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
TNT/docs
History
m1ngsama da8b77d625 docs: reorganize documentation structure 
- Move all documentation to docs/ directory for better organization
- Rewrite README.md following Linux kernel style (English only)
- Rename HACKING -> CONTRIBUTING.md
- Rename QUICKREF -> QUICKREF.md
- Rename README -> README.old
- Add comprehensive Development-Guide.md for contributors

Documentation structure:
- README.md: Project overview and quick start
- docs/Development-Guide.md: Complete developer manual
- docs/CONTRIBUTING.md: Contribution guidelines
- docs/DEPLOYMENT.md: Production deployment guide
- docs/SECURITY_QUICKREF.md: Security config reference
- docs/QUICKREF.md: Command cheat sheet

This aligns with Linux kernel documentation practices:
simple, organized, and accessible.
2026-02-07 23:31:53 +08:00
..
ANONYMOUS_ACCESS_SUMMARY.md docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
CHANGELOG.md docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
CICD.md docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
CONTRIBUTING.md docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
DEPLOYMENT.md docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
Development-Guide.md docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
EASY_SETUP.md docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
IMPLEMENTATION_SUMMARY.txt docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
QUICKREF.md docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
README.old docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
SECURITY_QUICKREF.md docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00
TEST_RESULTS.md docs: reorganize documentation structure 2026-02-07 23:31:53 +08:00

README.old 

TNT(1)                      User Commands                      TNT(1)

NAME
     tnt - terminal chat server with vim-style interface

SYNOPSIS
     tnt [-p port] [-h]

DESCRIPTION
     TNT (TNT's Not Tunnel) is a lightweight SSH chat server.
     Supports vim-style navigation and message history browsing.

INSTALLATION
     curl -sSL https://raw.githubusercontent.com/m1ngsama/TNT/main/install.sh | sh

     Or download binary from:
     https://github.com/m1ngsama/TNT/releases

USAGE
     Start server:
         tnt                    # Listen on port 2222
         tnt -p 3333           # Listen on port 3333
         PORT=3333 tnt         # Same as above

     Connect as client:
         ssh -p 2222 localhost

OPTIONS
     -p port    Listen on specified port (default: 2222)
     -h         Display help message

MODES
     INSERT     Type and send messages (default mode)
                ESC         Switch to NORMAL mode
                Enter       Send message
                Backspace   Delete character

     NORMAL     Browse message history
                i           Return to INSERT mode
                :           Enter COMMAND mode
                j/k         Scroll down/up
                g/G         Jump to top/bottom
                ?           Show help

     COMMAND    Execute commands
                :list       List online users
                :help       Show available commands
                ESC         Return to NORMAL mode

ENVIRONMENT
     PORT       Server port (default: 2222)

FILES
     messages.log    Message history (append-only)
     host_key        SSH host key (auto-generated)

EXAMPLES
     Start server on port 3000:
         PORT=3000 tnt

     Connect and set username:
         ssh -p 2222 localhost
         # Enter username when prompted

     Production deployment with systemd:
         sudo cp tnt.service /etc/systemd/system/
         sudo systemctl enable --now tnt

DIAGNOSTICS
     Build with debug symbols:
         make debug

     Check for memory leaks:
         make asan
         ASAN_OPTIONS=detect_leaks=1 ./tnt

     Run tests:
         ./test_basic.sh
         ./test_stress.sh 50 120

BUGS
     Report bugs at: https://github.com/m1ngsama/TNT/issues

SEE ALSO
     ssh(1), sshd(8)

     Project documentation:
         HACKING         Developer guide
         DEPLOYMENT.md   Production setup
         CICD.md         CI/CD workflow

AUTHOR
     Written by m1ng.

LICENSE
     MIT License. See LICENSE file for details.

TNT 1.0                       December 2025                      TNT(1)