Skip to content

Codechange: Comprehensive refactor of make rules and output structure#21

Open
zephyris wants to merge 1 commit into
mainfrom
make-restructure
Open

Codechange: Comprehensive refactor of make rules and output structure#21
zephyris wants to merge 1 commit into
mainfrom
make-restructure

Conversation

@zephyris

Copy link
Copy Markdown
Contributor

The repo set up so that binary outputs, TTF files and PNG preview images, were updated with each commit. This leads to rebase/merge messiness.

This is a refactor of the make rules and output structure to try to tidy this:

  • Separate all source files from generated files, source files are not moved, kept in openttd-sans/ etc.
  • Keeps TTF generation under make all rule, but now puts output TTFs in ttf/.
  • Do not track TTFs in repo (and in readme, point to releases for downloads).
  • Moves preview PNG image generation to a separate rule, make preview, and puts output PNGs in previews/.
  • Keep tracking preview images in repo (but update readme to indicate that they can be infrequently updated, eg. preparing for a release).
  • Fix readme links to new preview image locations.
  • Also remove old/legacy build bash scripts.

I'm not certain that this is the right solution, but seems sensible? Comments & criticism very welcome.

This change would break the OpenGFX2 build, as it clones this repo and expects to find the TTF files as part of the repo.

@LordAro LordAro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems fairly reasonable to me, other than the conflict of course ;)

Comment thread makefile
Comment thread makefile Outdated
Comment thread makefile Outdated
@zephyris

Copy link
Copy Markdown
Contributor Author

Hmm, not sure why it thinks there are conflicts - changes made, I'll get back to fixing the conflicts later.

Keeps TTF generation under `make all`, but now puts output TTFs in `ttf/`. Moves preview image generation to a separate rule, `make preview`, and puts outputs in `previews/`. Fix readme links as needed. Keep preview images in repo, but update readme to indicate that they can be infrequently updated, eg. on release. Remove TTFs from repo, instead point downloads to releases. Should prevent branches/PRs having version clashes with binary TTF and PNG files.
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.

2 participants