update readme

sxzgroup · Jan 3, 2025 · 05c16a2 · 05c16a2
1 parent eed9ef8
commit 05c16a2
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -8,8 +8,24 @@
 
 _Materials for 1st ML&QC Winter School at Nankai University_
 
+## Contents
+
+- `resources`: slides for QC introduction and lecture notes for QC by others.
+
+- `lectures`": jupyter notebooks on QC with code demos using TC-NG
+
 ## Setup
 
-To run the jupyter notebooks in `lectures`, please first `pip install -r requirements.txt`
+To run the jupyter notebooks in `lectures`, please first `pip install -r requirements.txt`. We suggest using anaconda to manage python environment, i.e.
+
+```bash
+git clone https://github.com/sxzgroup/qc_lecture.git
+cd qc_lecture
+
+conda create -n tc python=3.10 pip
+conda activate tc
+pip install -r requirements.txt
+jupyter notebook
+```
 
 To make a pull request, please first ensure formatting the notebooks locally by running `black .`
diff --git a/requirements.txt b/requirements.txt
@@ -5,4 +5,5 @@ jax
 qiskit
 matplotlib
 pylatexenc
+jupyter
 black[jupyter]