mirror of
https://github.com/dathere/100.dathere.com.git
synced 2025-12-18 08:09:25 +00:00
docs: improve README setup info
This commit is contained in:
parent
eca830a9ad
commit
8478b127d8
1 changed files with 4 additions and 9 deletions
13
README.md
13
README.md
|
|
@ -12,7 +12,7 @@ This codebase includes source code for "100 exercises with qsv" found at [100.da
|
|||
|
||||
Ensure you are using one of the following OS/software:
|
||||
|
||||
- Windows Subsystem for Linux 2 (not Windows) running Ubuntu
|
||||
- Windows Subsystem for Linux 2 (not Windows so that the bash kernel can work) running Ubuntu
|
||||
- macOS
|
||||
- Linux
|
||||
|
||||
|
|
@ -32,17 +32,12 @@ git clone https://github.com/dathere/100.dathere.com.git
|
|||
```
|
||||
|
||||
3. Change your directory into this folder `book`.
|
||||
4. Run `uv venv`, this should generate a `.venv` folder.
|
||||
5.
|
||||
|
||||
- On macOS and Linux
|
||||
- Run `source .venv/bin/activate`
|
||||
- On Windows
|
||||
- Run `.venv\Scripts\activate`
|
||||
4. Run `uv venv --python 3.11`, this should generate a `.venv` folder.
|
||||
5. On macOS and Linux run `source .venv/bin/activate`
|
||||
|
||||
6. Run `uv pip install -r requirements-local.txt`.
|
||||
7. Run `uv pip install -e ./bash_kernel` and then `python -m bash_kernel.install` to install the Bash kernel.
|
||||
8. You may need to add qsv to your `PATH` first. Then, run `jb build .` to build the book or save a `.md`, `.ipynb`, or `.yml` file in VS Code for the Run on Save extension to run relevant commands.
|
||||
8. You may need to add qsv to your `PATH` first. Then, run `jb build . --all` to build the book or save a `.md`, `.ipynb`, or `.yml` file in VS Code for the Run on Save extension to run relevant commands.
|
||||
9. Serve the build locally. For example using VS Code, click on `_build/html/index.html` and click Open with Live Server which should launch a local build of the website and should reload within a few seconds each time you save a `.md` or `.yml` file in VS Code (you may need to refresh the page once Run on Save is done each time). You may need to navigate to the proper URL such as http://localhost:5500/\_build/html/.
|
||||
|
||||

|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue