feat(docs): Include documentation about how to boot the app locally.
parent
7e6bbd3aeb
commit
ce29d187bc
11
README.md
11
README.md
|
@ -29,6 +29,17 @@ We have published a 1 hour lecture that provides a comprehensive overview of pro
|
||||||
- [Notebook with code](https://github.com/dair-ai/Prompt-Engineering-Guide/blob/main/notebooks/pe-lecture.ipynb)
|
- [Notebook with code](https://github.com/dair-ai/Prompt-Engineering-Guide/blob/main/notebooks/pe-lecture.ipynb)
|
||||||
- [Slides](https://github.com/dair-ai/Prompt-Engineering-Guide/blob/main/lecture/Prompt-Engineering-Lecture-Elvis.pdf)
|
- [Slides](https://github.com/dair-ai/Prompt-Engineering-Guide/blob/main/lecture/Prompt-Engineering-Lecture-Elvis.pdf)
|
||||||
|
|
||||||
|
---
|
||||||
|
## Running the guide locally
|
||||||
|
|
||||||
|
To run the guide locally, for example to check the correct implementation of a new translation, you will need to:
|
||||||
|
|
||||||
|
1. Install Node >=18.0.0
|
||||||
|
1. Install `pnpm` if not present in your system. Check [here](https://pnpm.io/installation) for detailed instructions.
|
||||||
|
1. Install the dependencies: `pnpm i next react react-dom nextra nextra-theme-docs`
|
||||||
|
1. Boot the guide with `pnpm dev`
|
||||||
|
2. Browse the guide at `http://localhost:3000/`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Guides
|
## Guides
|
||||||
|
|
Loading…
Reference in New Issue