Skip to content

Add Dockerfile and README.md instructions #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

samin-irtiza
Copy link

@samin-irtiza samin-irtiza commented Apr 25, 2025

This PR enhances the project by enabling the application to be run as a CLI tool using Docker. Users can now easily analyze codebases and generate tutorials without needing to install dependencies locally.

Key Updates:

  • Dockerization:

    • Builds a lightweight runtime image (65.8MB approximately as of now) for the CLI tool using PyInstaller and Docker.
    • Ensures the application binary is executable and ready to use.
  • Usage Instructions:

    • Added steps in the README for building and running the Docker container.
    • Users can pass arguments like --repo, --dir, and other CLI options directly to the Dockerized application.

Benefits:

  • Simplifies setup and usage by encapsulating the application in a Docker container.
  • Provides a consistent runtime environment for the CLI tool.

Users can now run the application with a single Docker command or set up a shell alias for even easier access.

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