Skip to content

Commit 634e5ba

Browse files
Update build instructions (#1582)
Fixed some incorrect build instructions and made some changes for consistency.
1 parent a83efb7 commit 634e5ba

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -210,20 +210,18 @@ You can build and test PennyLane demos locally using the QML CLI tool, allowing
210210
211211
> **Note:** Local HTML builds will differ visually from the production site or PR previews. These differences are expected; local builds are intended for functional testing rather than visual accuracy.
212212
213-
If you do not specify a `--format` option, the demo will be built in JSON format by default.
214-
215213
### Building a Demo in HTML Format
216214
217-
To build your demo in HTML format, navigate to the root directory of your demo and run:
215+
To build your demo in HTML format, navigate to the root directory of the repository and run:
218216
219217
```bash
220-
qml build --format html
218+
qml build --format html <name_of_your_demo>
221219
```
222220
223221
The generated HTML file will be located at:
224222
225223
```
226-
_build/html/demos/<name_of_your_tutorial>.html
224+
_build/html/demos/<name_of_your_demo>.html
227225
```
228226
229227
Open this file in your web browser to view the demo content.
@@ -233,7 +231,7 @@ Open this file in your web browser to view the demo content.
233231
To build your demo in JSON format, use:
234232
235233
```bash
236-
qml build --format json <demo_name>
234+
qml build --format json <name_of_your_demo>
237235
```
238236
239237
The output will be generated in the following directories:
@@ -243,6 +241,8 @@ The output will be generated in the following directories:
243241
244242
> **Note:** You may also add the `--execute` option to execute the demo during the build process.
245243
244+
If you do not specify a `--format` option, the demo will be built in JSON format by default.
245+
246246
## Support
247247
248248
- **Source Code:** https://github.com/PennyLaneAI/QML

0 commit comments

Comments
 (0)