Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added an english README version #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: added an english README version #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README_en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.<br />
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.