Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
OmitNomis committed Dec 29, 2023
1 parent 478cd85 commit c4b2cc4
Showing 1 changed file with 28 additions and 10 deletions.
38 changes: 28 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

0 comments on commit c4b2cc4

Please sign in to comment.