mirror of
https://github.com/BartoszJarocki/cv.git
synced 2024-11-25 07:54:35 +03:00
chore: update docs
This commit is contained in:
parent
478cd8582e
commit
c4b2cc4623
38
README.md
38
README.md
@ -6,24 +6,42 @@ Simple web app that renders minimalist CV with print-friendly layout.
|
||||
|
||||
Built with Next.js and shadcn/ui, deployed on Vercel.
|
||||
|
||||
# Features
|
||||
|
||||
- Setup only takes a few minutes [single config file](./src/data/resume-data.tsx)
|
||||
- Built using Next.js 14, React, Typescript, Shadcn/ui, TailwindCss
|
||||
- Auto generated Layout
|
||||
- Responsive for different devices
|
||||
- Optimized for Next.js and Vercel
|
||||
|
||||
# Getting Started Locally
|
||||
|
||||
1. Clone this repository to your local machine:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/BartoszJarocki/cv.git
|
||||
```
|
||||
```bash
|
||||
git clone https://github.com/BartoszJarocki/cv.git
|
||||
```
|
||||
|
||||
2. Move to the cloned directory
|
||||
|
||||
```bash
|
||||
cd cv
|
||||
```
|
||||
|
||||
3. Install dependencies:
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
4. Start the local Server:
|
||||
|
||||
```bash
|
||||
yarn dev
|
||||
```
|
||||
|
||||
```bash
|
||||
yarn dev
|
||||
```
|
||||
|
||||
5. Open the [Config file](./src/data/resume-data.tsx) and make changes
|
||||
|
||||
# License
|
||||
|
||||
[MIT](https://choosealicense.com/licenses/mit/)
|
||||
|
Loading…
Reference in New Issue
Block a user