Update to v1.0.0. Fix relative path for profile photo import. Create …

…public repository from provided template, with build scripts

.github/workflows/release.yml

@@ -1,13 +1,13 @@
 name: Package and push to registry repo
 on:
   push:
-    tags: [ v* ]
+    tags: [v*]
 
 env:
   # the repository to which to push the release version
   # usually a fork of typst/packages (https://github.com/typst/packages/)
   # that you have push privileges to
-  REGISTRY_REPO: author/typst-packages
+  REGISTRY_REPO: AsiSkarp/typst_packages
   # the path within that repo where the "<name>/<version>" directory should be put
   # for the Typst package registry, keep this as is
   PATH_PREFIX: packages/preview

CHANGELOG.md

@@ -1,13 +1,9 @@
-# [unreleased](https://github.com/<author>/<my-package>/releases/tag/<the-tag>)
+# [unreleased](https://github.com/AsiSkarp/grotesk-cv/releases/tag/v1.0.0)
 ## Added
 
 ## Removed
 
 ## Changed
 
-## Migration Guide from v0.1.X
 
 ---
-
-# [v0.1.0](https://github.com/<author>/<my-package>/releases/tag/v0.1.0)
-Initial Release

README.md

@@ -1,64 +1,91 @@
-# The `my-package` Package
-<div align="center">Version 0.1.0</div>
-
-A short description about the project and/or client.
-
-## Template adaptation checklist
-
-- [ ] Fill out `README.md`
-  - Change the `my-package` package name, including code snippets
-  - Check section contents and/or delete sections that don't apply
-- [ ] Check and/or replace `LICENSE` by something that suits your needs
-- [ ] Fill out `typst.toml`
-  - See also the [typst/packages README](https://github.com/typst/packages/?tab=readme-ov-file#package-format)
-- [ ] Adapt Repository URLs in `CHANGELOG.md`
-  - Consider only committing that file with your first release, or removing the "Initial Release" part in the beginning
-- [ ] Adapt or deactivate the release workflow in `.github/workflows/release.yml`
-  - to deactivate it, delete that file or remove/comment out lines 2-4 (`on:` and following)
-  - to use the workflow
-    - [ ] check the values under `env:`, particularly `REGISTRY_REPO`
-    - [ ] if you don't have one, [create a fine-grained personal access token](https://github.com/settings/tokens?type=beta) with [only Contents permission](https://stackoverflow.com/a/75116350/371191) for the `REGISTRY_REPO`
-    - [ ] on this repo, create a secret `REGISTRY_TOKEN` (at `https://github.com/[user]/[repo]/settings/secrets/actions`) that contains the so created token
-
-    if configured correctly, whenever you create a tag `v...`, your package will be pushed onto a branch on the `REGISTRY_REPO`, from which you can then create a pull request against [typst/packages](https://github.com/typst/packages/)
-- [ ] remove/replace the example test case
-- [ ] (add your actual code, docs and tests)
-- [ ] remove this section from the README
+<h1 align="center"> grotesk-cv </h1>
+<div align="center">Version 1.0.0</div>
 
-## Getting Started
 
-These instructions will get you a copy of the project up and running on the typst web app. Perhaps a short code example on importing the package and a very simple teaser usage.
+grotesk-cv provides a pair of elegant and simple, one-page CV and cover letter templates, inspired by  the [Brilliant-cv](https://typst.app/universe/package/brilliant-cv/) and [fireside](https://typst.app/universe/package/fireside/1.0.0/) templates.
+
+
+### Features 
+- Templates for multilingual CV and cover letter, enabled by flag 
+- Separation of styling and content
+- Customizable fonts, colors and icons
+
+## Preview
+
+| CV | Cover Letter |
+| :---: | :---: |
+| <img src="./examples/cv_example.png"> | <img src="./examples/cover_letter_example.png"> |
+
 
-```typ
-#import "@preview/my-package:0.1.0": *
 
-#show: my-show-rule.with()
-#my-func()
+## Getting Started
+To edit this template, changes are mostly made in either of two places. Changes to contact information or layout settings are made in `info.toml`. To change the section contents, navigate to the corresponding section file e.g. `content/profile.typ` to edit the **Profile** section. 
+
+### Adding or Removing Sections
+To add a new section, create a new `.typ` file in the `content` directory with the desired section name. To include the section in the CV, add the section at the desired position in either left or right panes in the `cv.typ` file. To remove sections, simply remove or comment-out the section name in the same list of section names in the `cv.typ` file. Sections are rendered in the order they appear in the list. The section column width can be adjusted in the `info.toml` file under the `left_pane_width` value.
+In the following example, the `projects.typ` section file has been created and is included in the left pane of the CV, and the `education.typ` section has been removed. 
+
+```rust
+#let left-pane = (
+  "profile",
+  "experience",
+  //"education",
+  "projects",
+)
 ```
 
-### Installation
+### Changing Profile Photo
+To change the profile photo, upload your image to the `content/img` folder. To enable the new image, update the `profile_image` value in `info.toml` with the name of your uploaded image. 
+
+
+### Changing FontAwesome Icons
+The template uses [FontAwesome](https://fontawesome.com/) for all icons. To change an icon, change the desired icon string in the `info.toml` file with the corresponding FontAwesome icon name. Icon strings can be found in the [cheat sheet](https://fontawesome.com/v4/cheatsheet/). Note that the icon strings must be written without the `fa-` prefix. 
+To disable the use of icons, set the `include_icons` value to `false`.
+
+
 
-A step by step guide that will tell you how to get the development environment up and running. This should example how to clone the repo and where to (maybe a link to the typst documentation on it), along with any pre-requisite software and installation steps.
+### Customizing Contact Information
+To change or add contact information, update the corresponding value under `[personal.info]` in the `info.toml` file. Information is rendered in the order it appears in the file. 
+To add a new contact information field, add a new variable under `[personal.info]` with the desired string value. Next, assign a valid FontAwesome icon string to a variable of the same name under `[personal.icon]`. 
+In the following example, a homepage field has been added to the contact information. 
 
+```toml
+[personal.info]
+homepage = "www.myawesomehomepage.com"
+
+[personal.icon]
+homepage = "globe"
 ```
-$ First step
-$ Another step
-$ Final step
+
+### Changing language
+The template provides the option to instantly change the language of the CV and cover letter by using a variable in the `info.toml` file. The template demonstrates the use of the `language` variable to switch between English and Spanish, but any language can be used, provided that the information is entered manually inside the corresponding section files. For instance, to change the alternate language to German, changes would have to be made in the section files to include the German text. 
+In the following example, the language of the **Profile** section has been changed from Spanish to German, and the required changes have been made in the `content/profile.typ` file. 
+
+
 ```
+// = Summary
+= #if include-icon [#fa-icon(icon) #h(5pt)] #if language == "en" [Summary] else if language == "ger" [Zusammenfassung]
 
-## Usage
+#v(5pt)
 
-A more in-depth description of usage. Any template arguments? A complicated example that showcases most if not all of the functions the package provides? This is also an excellent place to signpost the manual.
+#if language == "en" [
 
-```typ
-#import "@preview/my-package:0.1.0": *
+  Experienced Software Engineer specializing in artificial intelligence, machine learning, and robotics. Proficient in C++, Python, and Java, with a knack for developing sentient AI systems capable of complex decision-making. Passionate about ethical AI development and eager to contribute to groundbreaking projects in dynamic environments.
 
-#let my-complicated-example = ...
-```
+] else if language == "ger" [
+
+  Erfahrener Software-Ingenieur, der sich auf künstliche Intelligenz, maschinelles Lernen und Robotik spezialisiert hat. Er beherrscht C++, Python und Java und hat ein Händchen für die Entwicklung empfindungsfähiger KI-Systeme, die in der Lage sind, komplexe Entscheidungen zu treffen. Leidenschaft für ethische KI-Entwicklung und bestrebt, zu bahnbrechenden Projekten in dynamischen Umgebungen beizutragen.
+
+]
+
+``` 
+
+### Changing Fonts
+If using the template online with Typst Universe, multiple font types are available to use, a list of which can be found by pressing the `Ag` button. To use a different font, upload a `ttf` or `otf` file to the `content/fonts` folder and update the `font` value in the `info.toml` file with the name of the uploaded font.
+
+
+### Installation
 
-## Additional Documentation and Acknowledgments
+To use the template offline, clone this repository to your local machine. Typst can be used and rendered offline by installing the Typst CLI. My preferred workflow has been to use VSCode with the [Tinymist](https://github.com/Myriad-Dreamin/tinymist/releases) extension, which provides LSP support, syntax highlighting, and error checking, live rendered previews and automatic exports to PDF. 
 
-* Project folder on server:
-* Confluence link:
-* Asana board:
-* etc...
+Please feel free to fork this repository and create PRs for any changes or improvements.