Add readme

This commit is contained in:
Christoph Hagen 2023-08-23 16:46:58 +02:00
parent 7b1e86fe97
commit 7f5a9fbada
2 changed files with 18 additions and 0 deletions

16
README.md Normal file
View File

@ -0,0 +1,16 @@
# ResumeBuilder
A simple macOS app to display my resume, and export it to different formats.
Features:
- Display my resume as a single page
- Switch between German and English versions
- Choose between light and dark appearance
- Import additional languages or update the internal data (from JSON)
- Export the content as a PDF, JPG image, or as JSON data
Problems:
- The [ImageRenderer](https://developer.apple.com/documentation/swiftui/imagerenderer) doesn't respect the appearance (dark/light), so exports are always done with the light color scheme (hints welcome!).
- The `ImageRenderer` sometimes renders text in the wrong color (seems to be a bug).
- PDF exports are fairly large (> 2 MB) due to included fonts, which is a problem for some applications.

View File

@ -41,6 +41,7 @@
/* End PBXBuildFile section */
/* Begin PBXFileReference section */
E2329BB12A9651E200A1270E /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
E267D1702A8E0DE80069112B /* ResumeBuilder.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = ResumeBuilder.app; sourceTree = BUILT_PRODUCTS_DIR; };
E267D1732A8E0DE80069112B /* ResumeBuilderApp.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ResumeBuilderApp.swift; sourceTree = "<group>"; };
E267D1752A8E0DE80069112B /* CV.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CV.swift; sourceTree = "<group>"; };
@ -90,6 +91,7 @@
E267D1672A8E0DE80069112B = {
isa = PBXGroup;
children = (
E2329BB12A9651E200A1270E /* README.md */,
E267D1722A8E0DE80069112B /* ResumeBuilder */,
E267D1712A8E0DE80069112B /* Products */,
);