https://github.com/tw1ddle/geometrize-top-level-repo
Top level repository and developer's landing page for checking out the Geometrize project
https://github.com/tw1ddle/geometrize-top-level-repo
art cpp geometrize geometry-processing
Last synced: 6 months ago
JSON representation
Top level repository and developer's landing page for checking out the Geometrize project
- Host: GitHub
- URL: https://github.com/tw1ddle/geometrize-top-level-repo
- Owner: Tw1ddle
- License: other
- Created: 2021-10-31T18:42:31.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-23T20:47:03.000Z (over 1 year ago)
- Last Synced: 2024-01-23T22:07:41.610Z (over 1 year ago)
- Topics: art, cpp, geometrize, geometry-processing
- Language: Shell
- Homepage: https://www.geometrize.co.uk
- Size: 1.3 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.geometrize.co.uk/)
[](https://github.com/Tw1ddle/geometrize-top-level-repo/blob/master/LICENSE)
[](https://ci.appveyor.com/project/Tw1ddle/geometrize-top-level-repo)
Top level repository for the [Geometrize](https://www.geometrize.co.uk/) project, an app for geometrizing images into geometric primitives and associated tools.
[](https://www.geometrize.co.uk/)
## Developer Quickstart
Checkout this repository and then download the entire Geometrize codebase by running the [get_geometrize_projects.sh](https://github.com/Tw1ddle/geometrize-top-level-repo/blob/master/get_geometrize_projects.sh) script.
The Geometrize project is split across numerous git repositories and submodules - it comprises several separate, modular pieces of software.
Good places to start would be to build and run the C++ [minimal example program](https://github.com/Tw1ddle/geometrize-lib-example), the [Geometrize desktop application](https://github.com/Tw1ddle/geometrize), or the [web demo](https://github.com/Tw1ddle/geometrize-haxe-web).
To contribute, make a pull request or open an issue on the relevant repository. Write access to repositories may also be granted to trusted contributors.
## Project Structure
The project repositories are structured as follows:
TABLE-BEGINS
| Repository Name | Description | Automated Build Status |
| --------------------------------- | ----------- | ---------------------- |
| [geometrize-top-level-repo](https://github.com/Tw1ddle/geometrize-top-level-repo) | The top level Geometrize C++ repository and developer quickstart guide | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-top-level-repo) |
| [geometrize](https://github.com/Tw1ddle/geometrize) | The main Geometrize C++ desktop application repository. The submodules include translations, resources, sample images and scripts | [](https://ci.appveyor.com/project/Tw1ddle/geometrize) |
| [geometrize-docs](https://github.com/Tw1ddle/geometrize-docs) | Developer documentation generation and hosting for the Geometrize C++ application | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-docs) |
| [geometrize-functional-tests](https://github.com/Tw1ddle/geometrize-functional-tests) | Automated tests for the Geometrize C++ application | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-functional-tests) |
| [geometrize-gallery](https://github.com/Tw1ddle/geometrize-gallery) | Code repository and hosting for a collection of example geometrized images | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-gallery) |
| [geometrize-haxe](https://github.com/Tw1ddle/geometrize-haxe) | The Geometrize Haxe library repository | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-haxe) |
| [geometrize-haxe-demo](https://github.com/Tw1ddle/geometrize-haxe-demo) | A HaxeFlixel-based demo of the Geometrize Haxe library | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-haxe-demo) |
| [geometrize-haxe-example](https://github.com/Tw1ddle/geometrize-haxe-example) | A minimal Haxe usage example of the Geometrize Haxe library | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-haxe-example) |
| [geometrize-haxe-unit-tests](https://github.com/Tw1ddle/geometrize-haxe-unit-tests) | Unit tests for the Geometrize Haxe library | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-haxe-unit-tests) |
| [geometrize-haxe-web](https://github.com/Tw1ddle/geometrize-haxe-web) | Code repository for the Geometrize Haxe web application | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-haxe-web) |
| [geometrize-installer](https://github.com/Tw1ddle/geometrize-installer) | Installer and packaging code for the Geometrize C++ desktop application | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-installer) |
| [geometrize-lib](https://github.com/Tw1ddle/geometrize-lib) | The Geometrize C++ library repository. | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-lib) |
| [geometrize-lib-docs](https://github.com/Tw1ddle/geometrize-lib-docs) | Developer documentation generation and hosting for the Geometrize C++ library | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-lib-docs) |
| [geometrize-lib-example](https://github.com/Tw1ddle/geometrize-lib-example) | A minimal C++ usage example of the Geometrize C++ library | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-lib-example) |
| [geometrize-lib-fuzzing](https://github.com/Tw1ddle/geometrize-lib-fuzzing) | Fuzz tests for the Geometrize C++ library | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-lib-fuzzing) |
| [geometrize-lib-unit-tests](https://github.com/Tw1ddle/geometrize-lib-unit-tests) | Unit tests for the Geometrize C++ library | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-lib-unit-tests) |
| [geometrize-resources](https://github.com/Tw1ddle/geometrize-resources) | A collection of curated resources e.g. public domain images, for use with Geometrize | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-resources) |
| [geometrize-s3-bucket-downloader](https://github.com/Tw1ddle/geometrize-s3-bucket-downloader) | A frontend for downloading Geometrize installers (from an Amazon S3 bucket) | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-s3-bucket-downloader) |
| [geometrize-screenshots](https://github.com/Tw1ddle/geometrize-screenshots) | Hosting for a set of screenshots showing different parts of the Geometrize C++ application | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-screenshots) |
| [geometrize-scripts](https://github.com/Tw1ddle/geometrize-scripts) | A collection of scripts, mostly used for customizing the Geometrize C++ shape generation algorithms | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-scripts) |
| [geometrize-templates](https://github.com/Tw1ddle/geometrize-templates) | Template images and project settings for the Geometrize C++ application | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-templates) |
| [geometrize-translations](https://github.com/Tw1ddle/geometrize-translations) | Translations for the Geometrize C++ application user interface | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-translations) |
| [geometrize-tween-optimizer](https://github.com/Tw1ddle/geometrize-tween-optimizer) | A tool for creating visually appealing tweens between sets of geometric primitives | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-tween-optimizer) |
| [geometrize-tweens](https://github.com/Tw1ddle/geometrize-tweens) | A web-based demo showing tweens between media composed of geometric primitives | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-tweens) |
| [geometrize-twitter-bot](https://github.com/Tw1ddle/geometrize-twitter-bot) | A Twitter bot that geometrizes images found on Twitter, and tweets the results | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-twitter-bot) |
| [geometrize-twitter-bot-docs](https://github.com/Tw1ddle/geometrize-twitter-bot-docs) | Developer documentation generation and documentation hosting for the Geometrize Twitter bot | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-twitter-bot-docs) |
| [geometrize-web-export](https://github.com/Tw1ddle/geometrize-web-export) | Code for rendering exported shape data in different web formats | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-web-export) |
| [geometrize-website](https://github.com/Tw1ddle/geometrize-website) | A user-facing website and landing page for the Geometrize project | [](https://ci.appveyor.com/project/Tw1ddle/geometrize-website) |
TABLE-ENDS
The table above was generated via the [tabulate_git_repos_in_readme.sh](https://github.com/Tw1ddle/geometrize-top-level-repo/blob/master/tabulate_git_repos_in_readme.sh) script.
## Automated Builds
When a commit is made to the master branch of a repository, automated builds are triggered to build, test and deploy any artifacts. For example, when a commit is made to the [main Geometrize C++](https://github.com/Tw1ddle/geometrize) repository, a build job will build the latest changes
for Windows, Mac and Linux. If this succeeds, then a build job for the [Geometrize C++ installer](https://github.com/Tw1ddle/geometrize-installer) is triggered, to build installers for the latest revision of Geometrize.
The build trigger and deployment graph for the project is shown below:
The graph above was generated via the [generate_trigger_graph.sh](https://github.com/Tw1ddle/geometrize-top-level-repo/blob/master/generate_trigger_graph.sh) script.
## Licenses
Most of the Geometrize project is free software, with code usually falling under the copyleft GPL license or the open source MIT license. Check the individual repositories and submodules and their associated LICENSE files for more details.
## Notes
* Got an idea or suggestion? Open an issue on GitHub, or send Sam a message on [Twitter](https://twitter.com/Sam_Twidale).