diff --git a/README.md b/README.md index 9bcb765..60c6275 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -# RenderCV +
+

+RenderCV + +*A* $\LaTeX$ *CV/resume framework*. +

[![test](https://github.com/sinaatalay/rendercv/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/sinaatalay/rendercv/actions/workflows/test.yaml) [![coverage](https://coverage-badge.samuelcolvin.workers.dev/sinaatalay/rendercv.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/sinaatalay/rendercv) @@ -6,6 +11,8 @@ [![pypi-version](https://img.shields.io/pypi/v/rendercv?label=PyPI%20version&color=rgb(0%2C79%2C144))](https://pypi.python.org/pypi/rendercv) [![pypi-downloads](https://img.shields.io/pepy/dt/rendercv?label=PyPI%20downloads&color=rgb(0%2C%2079%2C%20144))](https://pypistats.org/packages/rendercv) +
+ RenderCV is a $\LaTeX$ CV/resume framework. It allows you to create a high-quality CV as a PDF from a YAML file with full Markdown syntax support and complete control over the $\LaTeX$ code. The primary motivation behind the RenderCV is to provide people with a concrete framework that will allow @@ -23,11 +30,6 @@ cv: name: John Doe location: Your Location email: youremail@yourdomain.com - social_networks: - - network: LinkedIn - username: yourusername - - network: GitHub - username: yourusername sections: this_is_a_section_title: - This is a type of entry, TextEntry—just a plain string. @@ -106,7 +108,7 @@ RenderCV also provides a general set of utilities that will automate most of the - create a new HTML document to be pasted into word processors for spelling and grammar checking. - create PNG files for each page. -### Why should I bother using RenderCV instead of $\LaTeX$? I can version-control $\LaTeX$ code too! +> Why should I bother using RenderCV instead of $\LaTeX$? I can version-control $\LaTeX$ code too! RenderCV is not a replacement for $\LaTeX$, but it's a general set of utilities designed to create and manage $\LaTeX$ CVs. If you're currently using $\LaTeX$ to create your CV, you should try RenderCV. Using your existing $\LaTeX$ themes in RenderCV is very easy. @@ -138,4 +140,4 @@ All contributions to RenderCV are welcome! For development, you will need to clo git clone --recursive https://github.com/sinaatalay/rendercv.git ``` -All code and development tool specifications are in `pyproject.toml`. Also, don't forget to read [the developer guide](https://docs.rendercv.com/developer_guide). \ No newline at end of file +All code and development tool specifications are in `pyproject.toml`. Also, don't forget to read [the developer guide](https://docs.rendercv.com/developer_guide).