Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
sinaatalay committed Nov 29, 2024
1 parent 9481794 commit 9eb8811
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 4 deletions.
48 changes: 47 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,47 @@
# rendercv-appdocs
# RenderCV App

We are developing an app on top of our open-source engine ([`rendercv` Python package](https://github.com/rendercv/rendercv)). The [web app](https://app.rendercv.com) is now available in beta, with iOS and Android versions coming soon.

## Mission

There isn't currently a cross-platform tool that allows people to store and maintain their CVs.

Therefore, people generally:

- Create their CVs using Microsoft Word, Google Docs, or Overleaf.
- Save them as PDFs in their cloud storage.
- Access the PDFs from their PCs or mobile phones whenever they need them.

But:

- Are we truly organized with our cloud storage, or do we end up searching through old emails to find our CVs?
- Can we effectively version-control our CVs? Can we find versions from, say, 2012?
- Is the formatting of our CVs good, or do we often receive feedback about bad formatting?
- If we spot a typo at the last minute, can we quickly fix it from our mobile devices?

We have solved these kinds of problems in other areas with apps before:

- **Photos:** We no longer need to worry about folders and files; photo apps organize them for us, doing a much better job because they're tailored for it.
- **Notes:** We don't need to keep track of lots of Word files anymore; we have tools like Notion and Obsidian.
- **Music:** We used to store music as MP3 files in our folders. Now, we have Spotify, Apple Music, and YouTube Music.

All of these examples share a common idea: they are purpose-built apps designed specifically for their applications. Yet, we don’t have a purpose-built CV app that embodies this same idea.

Imagine an app for CVs:

- You simply write your content and get a very professional CV as a PDF.
- You store your CVs and lock their versions where everything is securely stored.
- You can access them from your mobile device and share any version of your CV with a click.
- You can fix typos directly from your mobile app.
- You even have the option to bring your own LaTeX templates to the app.
- There is a platform where people can share their templates, allowing you to choose the best one for your purpose.

We are building this app on top of our open-source engine so that your CVs generated with RenderCV will always be reproducible, and you can use RenderCV without using the app.

## Comments and Feedback

We aim to complete this app for all platforms as quickly as possible, and we'd love to hear your feedback and comments as we move forward. Your input is highly valued.

Please share your comments in [this discussion](https://github.com/rendercv/rendercv-app/discussions/1).

If you encounter any bugs, issues, or have feature requests, please report them [here](https://github.com/rendercv/rendercv-app/issues).
2 changes: 1 addition & 1 deletion docs/assets/images/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/update_entry_figures.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
import ruamel.yaml

import rendercv.data as data
import rendercv.renderer as renderer

repository_root = pathlib.Path(__file__).parent.parent
rendercv_path = repository_root / "rendercv"
Expand Down
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ theme:
- content.action.edit # view source button for pages
- navigation.footer # the previous and next buttons in the footer
- navigation.indexes # allow mother pages to have their own index pages
# - navigation.tabs # render classical type of navbar at top
- navigation.instant # instant navigation for faster page loads
- navigation.instant.prefetch # prefetch pages for instant navigation
- navigation.instant.progress # show progress bar for instant navigation
Expand Down

0 comments on commit 9eb8811

Please sign in to comment.