Skip to content

Commit 8f314b2

Browse files
committed
Update README with Nix info
1 parent 02072a2 commit 8f314b2

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

README.md

+21-8
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,25 @@ This repository contains the sources for the Shiny for Python web site.
22

33
## Setup and build
44

5-
Install Quarto. Because Quarto is under rapid development, it's best to install by cloning the Quarto git repository and running a setup script; after that, just doing `git pull` will make the latest version available, without needing to run an installer each time. [Instructions here](https://github.com/quarto-dev/quarto-cli#development-version).
5+
6+
**Prerequisites:** Make sure you have the following installed. (Note that if you have Nix installed on your system, you do not need to install these manually because Nix can provide them automatically.)
7+
8+
- Quarto 1.3.x
9+
- Python
10+
- R
611

712
Clone this repository:
813

914
```bash
10-
git clone https://github.com/rstudio/pyshiny-site.git
11-
cd pyshiny-site
15+
git clone https://github.com/posit-dev/py-shiny-site.git
16+
cd py-shiny-site
17+
```
18+
19+
**Optional:** If you are using Nix, you can get a working development environment with all of the prerequisites by simply running `nix develop`. This will enter a shell with correct versions of the dependencies already installed.
20+
21+
```bash
22+
# Optional, if you have Nix installed
23+
nix develop
1224
```
1325

1426
Set up git submodules:
@@ -36,14 +48,15 @@ $ make
3648
all Build everything
3749
submodules Update git submodules to commits referenced in this repository
3850
submodules-pull Pull latest commits in git submodules
39-
build_pkgs Build and install htmltools and shiny
40-
shinylive Build JS components for shinylive
41-
pypi Create a local pypi repository with htmltools and shiny
42-
api_docs Build shiny API documentation
51+
quarto-exts Update Quarto extensions
52+
deps Install build dependencies
53+
quartodoc Build qmd files for Shiny API docs
4354
site Build website
4455
serve Build website and serve
4556
clean Remove Quarto website build files
46-
distclean Remove all build files (packages, API docs, shinylive, Quarto website)
57+
clean-exts Remove Quarto extensions
58+
clean-venv Remove venv files
59+
distclean Remove all build files (Quarto website, quarto extensions, venv)
4760
```
4861

4962

0 commit comments

Comments
 (0)