Skip to content

Commit 58bac05

Browse files
committed
update readme
1 parent 838671b commit 58bac05

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
Temporary branch being used to rewrite ReactPy's documentation.
22

3-
Many of these pages are in progress, and are using the [original ReactJS pages](https://beta.reactjs.org/learn) as placeholders.
3+
Many of these pages are in progress, and are using the [original ReactJS docs](https://react.dev/learn) as placeholders.
44

55
See live preview here: https://reactive-python.github.io/reactpy
6+
7+
In order to set up an environment to develop these docs...
8+
9+
1. Install [Python](https://www.python.org/downloads/) 3.9 or higher
10+
2. Fork and clone this repository
11+
3. _Optional_: Create a Python virtual environment with the following command: `python3 -m venv venv`
12+
4. _Optional_: Activate the virtual environment (this method will vary based on operating system)
13+
5. Install the dependencies with the following command: `pip install -r docs/requirements.txt`
14+
6. Run the following command: `mkdocs serve`
15+
7. Follow the on-screen prompts to view the documentation in your browser
16+
8. You can now edit the markdown files located within `docs/src/` and see the changes in real time
17+
18+
Feel free to PR this branch with any changes you make to the documentation. If you have any questions, feel free to ask in the [Discord server](https://discord.gg/uNb5P4hA9X).

0 commit comments

Comments
 (0)