diff --git a/README.md b/README.md index 537c4b0..d493548 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ -RenderCV allows you to create a high-quality CV as a PDF from a YAML input file. It supports full Markdown syntax and gives you complete control over the $\LaTeX$ code. +RenderCV allows you to create a high-quality CV as a PDF from a YAML input file. It supports Markdown syntax and gives you complete control over the $\LaTeX$ code. The primary motivation behind the RenderCV is to provide people with a concrete framework that allows diff --git a/docs/developer_guide/index.md b/docs/developer_guide/index.md index d5ab03a..77aba7c 100644 --- a/docs/developer_guide/index.md +++ b/docs/developer_guide/index.md @@ -21,6 +21,8 @@ The source code is thoroughly documented and well-commented, making it an enjoya - `docs`: For building the documentation. - `test`: For testing RenderCV. + Create the virtual environments with the following commands. + ```bash hatch env create default hatch env create docs diff --git a/docs/index.md b/docs/index.md index 7cefbf4..a1036f6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,8 +15,7 @@ - -RenderCV allows you to create a high-quality CV as a PDF from a YAML input file. It supports full Markdown syntax and gives you complete control over the $\LaTeX$ code. +RenderCV allows you to create a high-quality CV as a PDF from a YAML input file. It supports Markdown syntax and gives you complete control over the $\LaTeX$ code. The primary motivation behind the RenderCV is to provide people with a concrete framework that allows diff --git a/rendercv/__init__.py b/rendercv/__init__.py index c1cd6f1..d5603f5 100644 --- a/rendercv/__init__.py +++ b/rendercv/__init__.py @@ -1,8 +1,8 @@ """RenderCV package. -RenderCV is a LaTeX CV/resume framework that 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. +RenderCV is a $\LaTeX$ CV/resume framework that allows you to create a high-quality CV +as a PDF from a YAML file with Markdown syntax support and complete control over the +$\LaTeX$ code. """ __version__ = "1.11" diff --git a/rendercv/data_models.py b/rendercv/data_models.py index e7e90e7..9304097 100644 --- a/rendercv/data_models.py +++ b/rendercv/data_models.py @@ -1460,7 +1460,7 @@ def get_a_sample_data_model( ( "[RenderCV](https://github.com/sinaatalay/rendercv) is a LaTeX-based" " CV/resume framework. It allows you to create a high-quality CV or" - " resume as a PDF file from a YAML file, with **full Markdown syntax" + " resume as a PDF file from a YAML file, with **Markdown syntax" " support** and **complete control over the LaTeX code**." ), (