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

refactor: change build system, revamp docs & speedup generation #19

Merged
merged 18 commits into from
May 28, 2024

Conversation

sgoudham
Copy link
Contributor

@sgoudham sgoudham commented May 27, 2024

This PR aims to give the repository a full overhaul, making it much easier to install and maintain.

TODO:

  • Speed up script exponentially. Starting from being unable to build to all flavours/accents in under 4 minutes.
  • Store PNGs in the repository
    - The PNGs are currently built everytime into a new build/ directory. This process calls inkscape over thousands of times each time. We should build the PNGs once into the same directory as the SVGs instead of a whole new directory so that the cache mechanism works properly.
  • Tidy up makefile/build.sh script, add debug logging, etc.
  • Add justfile for nicer developer experience, should aim to be optional so that end users don't need to install it.
  • Rename zips to be lowercase, match with new GTK standard.

We still need to figure out a process of recolouring the SVGs fast but it looks
like they were hand-edited and put into source control. This is fine for the
time being and I'm not looking to optimise/improve that process.

BEGIN_COMMIT_OVERRIDE
build: generate zips in lowercase
perf: exponential speed-up in build time
END_COMMIT_OVERRIDE

Definitely shouldn't have been committed
into source control in the first place.
@sgoudham sgoudham marked this pull request as ready for review May 28, 2024 01:54
@sgoudham sgoudham changed the title refactor!: complete overhaul refactor: change build system, revamp docs & speedup generation May 28, 2024
@sgoudham sgoudham merged commit a8aa241 into main May 28, 2024
1 check passed
@sgoudham sgoudham deleted the refactor/overhaul branch May 28, 2024 02:05
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.

None yet

2 participants