mirror of
https://github.com/m1ngsama/TNT.git
synced 2026-02-08 00:54:03 +00:00
m1ngsama
da8b77d625
- 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.
37 lines
837 B
Markdown
37 lines
837 B
Markdown
TNT Quick Reference
|
|
===================
|
|
|
|
BUILD
|
|
make production build
|
|
make debug debug symbols
|
|
make asan memory sanitizer
|
|
make release optimized + stripped
|
|
make clean remove artifacts
|
|
|
|
TEST
|
|
./test_basic.sh basic functionality
|
|
./test_stress.sh 20 60 stress test (20 clients, 60s)
|
|
|
|
DEBUG
|
|
ASAN_OPTIONS=detect_leaks=1 ./tnt
|
|
valgrind --leak-check=full ./tnt
|
|
make check
|
|
|
|
STRUCTURE
|
|
src/main.c entry, signals
|
|
src/ssh_server.c SSH, threads
|
|
src/chat_room.c broadcast
|
|
src/message.c persistence
|
|
src/tui.c rendering
|
|
src/utf8.c unicode
|
|
|
|
LIMITS
|
|
64 clients max
|
|
100 messages in RAM
|
|
1024 bytes/message
|
|
|
|
FILES
|
|
HACKING dev guide
|
|
CHANGELOG.md changes
|
|
messages.log chat log
|
|
host_key SSH key
|