From 1f85fe3ce375c70f10bcabe7665e297c9c9949e8 Mon Sep 17 00:00:00 2001 From: 0xflotus <0xflotus@gmail.com> Date: Mon, 3 Aug 2020 02:09:38 +0200 Subject: [PATCH] docs: added an english README version --- README_en.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README_en.md diff --git a/README_en.md b/README_en.md new file mode 100644 index 0000000..6bccb07 --- /dev/null +++ b/README_en.md @@ -0,0 +1,24 @@ +# cv +currĂ­culum vitae generator + +This project uses [JSON Resume](https://jsonresume.org/). + +## Getting started + +1. Clone this repository +2. Install all dependencies: `npm install` + +## Available commands + +### `npm run start` + +Runs a local server and generates an html file in the `public/index.html` directory.
+Open [http://localhost:4000](http://localhost:4000) to view in your browser. + +### `npm run export:html` + +Generates an `index.html` file in the root directory. It is used as an entry point for the online version. + +### `npm run export:pdf` + +Generates a `cv.pdf` file in the root directory for personal use.