Skip to content
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

Add a minimal Makefile for core project tasks #7

Open
glenux opened this issue Dec 24, 2024 · 0 comments
Open

Add a minimal Makefile for core project tasks #7

glenux opened this issue Dec 24, 2024 · 0 comments

Comments

@glenux
Copy link

glenux commented Dec 24, 2024

Description

The project currently lacks a Makefile to standardize and simplify common development and build tasks. To enhance usability and reduce onboarding complexity, we propose adding a minimalist Makefile focusing on essential functionality. This first version will support core tasks like building, cleaning, testing, and providing a help summary.

Goals

  • Provide a lightweight, easy-to-use Makefile.
  • Focus on core functionality needed during early development.
  • Leave room for future expansion as the project evolves.

Proposed Targets

  1. build

    • Purpose: Compile the project binary.
    • Implementation: Run crystal build src/main.cr --release.
    • Why: Compiling the project is the primary task during development.
  2. clean

    • Purpose: Remove build artifacts.
    • Implementation: Delete all binaries and intermediate files (e.g., ./bin, ./obj).
    • Why: Cleaning ensures a consistent build environment.
  3. test

    • Purpose: Run the project's test suite.
    • Implementation: Execute crystal spec or an equivalent test command.
    • Why: Verifying functionality is critical for development.
  4. help

    • Purpose: Display all available targets and their descriptions.
    • Implementation: Print a concise list of targets and their purposes.
    • Why: Assists developers in understanding and using the Makefile.
@glenux glenux moved this to Backlog in Poietic Generator Roadmap Dec 24, 2024
@glenux glenux moved this from Backlog to To Do in Poietic Generator Roadmap Dec 24, 2024
@glenux glenux moved this from To Do to In review in Poietic Generator Roadmap Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In review
Development

No branches or pull requests

1 participant