From 30e93ab10309de2921faf504e1202a9bf188d451 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=93scar=20N=C3=A1jera?= Date: Tue, 2 Jun 2020 00:10:44 +0200 Subject: [PATCH] Review readme --- doc/content/post/basic_config.md | 2 +- doc/content/post/goal.md | 11 +++--- doc/content/post/installation.md | 2 +- doc/content/post/latex_export.md | 6 ++-- doc/content/post/license.md | 19 +++++++++++ doc/content/post/tips.md | 22 ++++++++++++ readme.org | 58 +++++++++++++++++++++++++++----- 7 files changed, 103 insertions(+), 17 deletions(-) create mode 100644 doc/content/post/license.md create mode 100644 doc/content/post/tips.md diff --git a/doc/content/post/basic_config.md b/doc/content/post/basic_config.md index 4ab5c85..36b7bed 100644 --- a/doc/content/post/basic_config.md +++ b/doc/content/post/basic_config.md @@ -19,7 +19,7 @@ put your foreseen job. | Field | Description | |----------|----------------------------------------------------| | TITLE | Desired job | -| AUTHOR | Who you are? | +| AUTHOR | Who are you? | | EMAIL | Your contact email | | ADDRESS | Mailing address, this can span over multiple lines | | HOMEPAGE | URL of your website | diff --git a/doc/content/post/goal.md b/doc/content/post/goal.md index f481cf7..d1739c2 100644 --- a/doc/content/post/goal.md +++ b/doc/content/post/goal.md @@ -5,11 +5,14 @@ draft = false weight = 1001 +++ -This project aims to generate from an org-mode file with reasonably ordered -items a latex file which compiles into a reasonably nice CV. In the same -spirit the org-mode file must export to markdown so that it can be uses for -web based CV. +This project exports an org-mode file with reasonably structured items into +a latex file, which compiles into a nice CV. In the same spirit the +org-mode file may export to markdown so that it can be used for a web based +CV. - Online documentation in - Development happens in the gitlab repository: - There is a mirror in github for backup: + +This project dog feeds itself and produces the examples on this +documentation page directly. diff --git a/doc/content/post/installation.md b/doc/content/post/installation.md index 154ada4..0f158b2 100644 --- a/doc/content/post/installation.md +++ b/doc/content/post/installation.md @@ -2,7 +2,7 @@ title = "Installation" author = ["Óscar Nájera"] draft = false -weight = 1001 +weight = 1002 +++ This project is not on MELPA so you have to do a manual installation. First diff --git a/doc/content/post/latex_export.md b/doc/content/post/latex_export.md index 2a473e8..45a5842 100644 --- a/doc/content/post/latex_export.md +++ b/doc/content/post/latex_export.md @@ -8,9 +8,9 @@ weight = 1004 ## Using modern-cv {#using-modern-cv} [moderncv](https://www.ctan.org/tex-archive/macros/latex/contrib/moderncv) is a standard \\(\LaTeX\\) package that you can find in many of your -latex distributions. For I maintain for personal purposes a fork of it to -better work with my use case at -Feel free to use any or even your personal fork for your desired use case. +latex distributions. I maintain a fork of it, to work with my use case at + Feel free to use any or even your +personal fork for your desired use case. To configure the export for moderncv you need the addition options in your org file. diff --git a/doc/content/post/license.md b/doc/content/post/license.md new file mode 100644 index 0000000..f4929f2 --- /dev/null +++ b/doc/content/post/license.md @@ -0,0 +1,19 @@ ++++ +title = "License" +author = ["Óscar Nájera"] +draft = false +weight = 1006 ++++ + +> org-cv +> Copyright (C) 2018-2020 Óscar Nájera +> +> This program is free software: you can redistribute it and/or modify +> it under the terms of the GNU General Public License as published by +> the Free Software Foundation, either version 3 of the License, or +> (at your option) any later version. +> +> This program is distributed in the hope that it will be useful, +> but WITHOUT ANY WARRANTY; without even the implied warranty of +> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +> GNU General Public License for more details. diff --git a/doc/content/post/tips.md b/doc/content/post/tips.md new file mode 100644 index 0000000..4249a66 --- /dev/null +++ b/doc/content/post/tips.md @@ -0,0 +1,22 @@ ++++ +title = "Tips" +author = ["Óscar Nájera"] +draft = false +weight = 1007 ++++ + +If you have found this project useful. Please consider giving back. You can +kindly tip me for this project + +Stellar +: GDPTOFND6HSE5AVHPRXOCJFOA6NPFB65JAEWKTN23EBUGBB2AU4PLIBD + +liberapay +: [Titan-C](https://liberapay.com/Titan-C/) + +
+ + + + +
diff --git a/readme.org b/readme.org index 05ac1ef..eaa87a0 100644 --- a/readme.org +++ b/readme.org @@ -10,15 +10,18 @@ :PROPERTIES: :EXPORT_FILE_NAME: goal :END: -This project aims to generate from an org-mode file with reasonably ordered -items a latex file which compiles into a reasonably nice CV. In the same -spirit the org-mode file must export to markdown so that it can be uses for -web based CV. +This project exports an org-mode file with reasonably structured items into +a latex file, which compiles into a nice CV. In the same spirit the +org-mode file may export to markdown so that it can be used for a web based +CV. - Online documentation in [[https://titan-c.gitlab.io/org-cv/]] - Development happens in the gitlab repository: https://gitlab.com/Titan-C/org-cv - There is a mirror in github for backup: https://github.com/Titan-C/org-cv +This project dog feeds itself and produces the examples on this +documentation page directly. + * Installation :PROPERTIES: :EXPORT_FILE_NAME: installation @@ -52,7 +55,7 @@ put your foreseen job. | Field | Description | |----------+----------------------------------------------------| | TITLE | Desired job | -| AUTHOR | Who you are? | +| AUTHOR | Who are you? | | EMAIL | Your contact email | | ADDRESS | Mailing address, this can span over multiple lines | | HOMEPAGE | URL of your website | @@ -117,9 +120,9 @@ I write about awesome stuff I do. ** Using modern-cv [[https://www.ctan.org/tex-archive/macros/latex/contrib/moderncv][moderncv]] is a standard \(\LaTeX\) package that you can find in many of your -latex distributions. For I maintain for personal purposes a fork of it to -better work with my use case at https://github.com/Titan-C/moderncv.git -Feel free to use any or even your personal fork for your desired use case. +latex distributions. I maintain a fork of it, to work with my use case at +https://github.com/Titan-C/moderncv.git Feel free to use any or even your +personal fork for your desired use case. To configure the export for moderncv you need the addition options in your org file. @@ -230,6 +233,45 @@ exclude some tags during export. You are responsible for styling your website. +* License + :PROPERTIES: + :EXPORT_FILE_NAME: license + :END: +#+begin_quote + org-cv + Copyright (C) 2018-2020 Óscar Nájera + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. +#+end_quote + +* Tips + :PROPERTIES: + :EXPORT_FILE_NAME: tips + :END: + +If you have found this project useful. Please consider giving back. You can +kindly tip me for this project + +- Stellar :: GDPTOFND6HSE5AVHPRXOCJFOA6NPFB65JAEWKTN23EBUGBB2AU4PLIBD +- liberapay :: [[https://liberapay.com/Titan-C/][Titan-C]] + + +#+BEGIN_EXPORT md +
+ + + + +
+#+END_EXPORT * Local Variables :ARCHIVE: # Local Variables: