Skip to content

Audit and Cleanup of Repository Makefiles #20

@Nayggets

Description

@Nayggets

Description:
Many Makefiles in the repository contain commands that no longer work, reference files that no longer exist, or are not easy to use. This can causes errors during the use of Hybrogen and makes the repository harder to maintain and to use. Makefiles are the cornerstone of an open-source repository; they need to work perfectly and be easy to use.

Objectives:

  1. Test all Makefiles to identify broken or unused commands.
  2. Fix any commands that no longer work.
  3. Remove or comment out obsolete or redundant instructions.
  4. Rewrite commands that are not easy to use and add more comments for each command.
  5. If a command is particularly difficult for a typical user, provide documentation (in comments or in a README).

Success Criteria:

  • All Makefiles run correctly without errors.
  • All Makefiles are easy to use and understand.
  • No unnecessary or obsolete commands remain in any Makefile.
  • Existing functionality continues to compile as expected.
  • All Makefiles are documented (via comments or README).

Note:
It might be helpful to add automated tests for all Makefiles to simplify CI/CD workflows and accelerate debugging and plot generation.

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions