Skip to content

Conversation

@luongnv89
Copy link
Contributor

@luongnv89 luongnv89 commented Feb 8, 2026

Summary

  • Enhanced README.md with license/CI badges, key features, one-line install instructions, usage examples, project structure, platform support table, and documentation links
  • Added CONTRIBUTING.md with development setup, branching strategy, conventional commits, PR process, and coding standards
  • Added CODE_OF_CONDUCT.md (Contributor Covenant v2.0), SECURITY.md (vulnerability reporting policy)
  • Added GitHub templates: bug report, feature request, and PR template — all customized for a C/DPI project
  • Added docs/ARCHITECTURE.md, docs/DEVELOPMENT.md, docs/DEPLOYMENT.md, docs/CHANGELOG.md
  • Added install.sh — one-line install script supporting Linux (apt, dnf, yum, pacman, apk, zypper) and macOS (Homebrew) with auto-detection of OS, architecture, and dependencies
  • Fixed install.sh to use $SUDO wrapper instead of hardcoded sudo, enabling use in Docker containers running as root
  • Fixed GCC 15 compatibility: updated old-style K&R empty-parameter declarations in smb.h and proto_smb.c that caused conflicting type errors
  • Updated CI workflow (c-cpp.yml) to reference main branch instead of master
  • Extended .gitignore with additional build output and IDE patterns

Test plan

  • Verify install.sh runs in Docker container (Ubuntu 26.04, GCC 15, ARM64) — tested successfully
  • Verify install.sh runs on macOS with Homebrew
  • Verify custom install path works: curl -sSL ... | MMT_BASE=/tmp/mmt bash
  • Verify README renders correctly on GitHub
  • Verify issue templates appear in GitHub Issues → New Issue
  • Verify PR template appears when opening a new PR
  • Verify CI workflow triggers on pushes/PRs to main
  • Review documentation links in README resolve correctly

Prepare the repository for open-source readiness with standard
community files: CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md,
GitHub issue/PR templates, and documentation structure (ARCHITECTURE,
DEVELOPMENT, DEPLOYMENT). Enhanced README with badges, features,
quick start guide, and usage examples. Updated CI workflow to
reference main branch.
Add agents-instructions.md with step-by-step setup guide covering
system packages, build configuration, compilation, installation,
library path setup, and verification for Linux and macOS platforms.
Includes permission gates, troubleshooting table, and linking
quick reference.
Untrack agent-instructions.md and agents-instructions.md, and add
ignore patterns for AI dev tools (Claude, Cursor, Copilot, Aider,
Continue, Warp) to prevent them from being committed.
Keep agents-instructions.md as a tracked project file while
continuing to ignore agent-instructions.md as a local dev tool file.
Supports Linux (apt, dnf, yum, pacman, apk, zypper) and macOS
(Homebrew) with auto-detection of OS, architecture, and
dependencies. Configurable via environment variables (MMT_BASE,
BRANCH, JOBS, SKIP_DEPS).
@luongnv89 luongnv89 changed the title Add open-source community files and enhance documentation Add open-source community files, documentation, and install script Feb 8, 2026
Move manual build instructions under a separate heading and
add curl/wget one-liner examples with custom options.
- Use $SUDO wrapper instead of hardcoded sudo (works when running
  as root in Docker containers)
- Fix old-style K&R function declarations in smb.h that cause
  conflicting type errors with GCC 15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant