Some changes to readme
This commit is contained in:
parent
11590634a2
commit
6dc35331b0
30
README.md
30
README.md
@ -39,15 +39,18 @@
|
|||||||
|
|
||||||
## Prerequisite
|
## Prerequisite
|
||||||
|
|
||||||
1. It is required to have NodeJs with version 8.5 or higher
|
1. It is required to have Node.js with version 8.5.0 or higher. To see what version of Node.js is installed on your machine type the following command in the terminal:
|
||||||
|
|
||||||
2. If you do not have installed node.js in your machine then go to [this link](https://nodejs.org/en/download/) in order to install node.
|
```
|
||||||
|
node -v
|
||||||
|
```
|
||||||
|
|
||||||
|
2. If you do not have installed Node.js in your machine then go to [this link](https://nodejs.org/en/download/) in order to install node.
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
|
|
||||||
best-resume-ever requires at least node v.8.5.0.
|
|
||||||
|
|
||||||
1. Clone this repository.
|
1. Clone this repository.
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/salomonelli/best-resume-ever.git
|
git clone https://github.com/salomonelli/best-resume-ever.git
|
||||||
```
|
```
|
||||||
@ -56,50 +59,47 @@ git clone https://github.com/salomonelli/best-resume-ever.git
|
|||||||
|
|
||||||
3. Run `npm install`.
|
3. Run `npm install`.
|
||||||
|
|
||||||
4. Customize your resume in the `resume/` directory: edit your data `data.yml` and replace your profile-picture `id.jpg`.
|
4. Customize your resume in the `resume/` directory: edit your data `data.yml` and replace the default profile-picture `id.jpg` with your picture. Rename your picture as `id.jpg` and copy it in the `resume/` directory.
|
||||||
|
|
||||||
5. Preview resumes with `npm run dev`.
|
5. Preview resumes with `npm run dev`. The command will start a server instance and listen on port 8080. Open (http://localhost:8080/) in your browser. The page will show some resume previews. To see the preview of your resume, with your picture and data, click on one layout that you like and the resume will be opened in the same window.
|
||||||
|
|
||||||
6. Export with `npm run export`.
|

|
||||||
|
|
||||||
|
|
||||||
|
6. Export your resume as pdf by running the command `npm run export`. In order to avoid errors due to the concurrency of two `npm run` commands, stop the execution of the previus `npm run dev` and then type the export command.
|
||||||
|
|
||||||
All resumes will be exported to the `pdf/` folder.
|
All resumes will be exported to the `pdf/` folder.
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
|
||||||
## Creating and Updating Templates
|
## Creating and Updating Templates
|
||||||
|
|
||||||
Please read the <a href="DEVELOPER.md">developer docs</a> on how to create or update templates.
|
Please read the <a href="DEVELOPER.md">developer docs</a> on how to create or update templates.
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
Feel free to add your own templates, language supports, fix bugs or improve the docs. Any kind of help is appreciated! If you make any kind of changes to an existing template, please commit them as new templates.
|
Feel free to add your own templates, language supports, fix bugs or improve the docs. Any kind of help is appreciated! If you make any kind of changes to an existing template, please commit them as new templates.
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
This project uses several open source packages:
|
This project uses several open source packages:
|
||||||
|
|
||||||
* <a href="https://github.com/vuejs/vue" target="_blank">Vue</a>
|
- <a href="https://github.com/vuejs/vue" target="_blank">Vue</a>
|
||||||
* <a href="https://github.com/GoogleChrome/puppeteer" target="_blank">Puppeteer</a>
|
- <a href="https://github.com/GoogleChrome/puppeteer" target="_blank">Puppeteer</a>
|
||||||
* <a href="https://github.com/less/less.js" target="_blank">LESS</a>
|
- <a href="https://github.com/less/less.js" target="_blank">LESS</a>
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
> [sarasteiert.com](https://www.sarasteiert.com) ·
|
> [sarasteiert.com](https://www.sarasteiert.com) ·
|
||||||
> GitHub [@salomonelli](https://github.com/salomonelli) ·
|
> GitHub [@salomonelli](https://github.com/salomonelli) ·
|
||||||
> Twitter [@salomonelli](https://twitter.com/salomonelli)
|
> Twitter [@salomonelli](https://twitter.com/salomonelli)
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
[MIT](https://github.com/salomonelli/best-resume-ever/blob/master/LICENCE.md)
|
[MIT](https://github.com/salomonelli/best-resume-ever/blob/master/LICENCE.md)
|
||||||
|
|||||||
BIN
readme-images/resumePreviews.png
Normal file
BIN
readme-images/resumePreviews.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 132 KiB |
Loading…
x
Reference in New Issue
Block a user