From 05c16a28984960a7c64751ed3ee2863eb8854e9e Mon Sep 17 00:00:00 2001
From: refraction-ray <kcanamgal@foxmail.com>
Date: Fri, 3 Jan 2025 13:12:49 +0800
Subject: [PATCH] update readme

---
 README.md        | 18 +++++++++++++++++-
 requirements.txt |  1 +
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6a2a445..40833e3 100644
--- 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
index af69be3..a7a51dd 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,4 +5,5 @@ jax
 qiskit
 matplotlib
 pylatexenc
+jupyter
 black[jupyter]
\ No newline at end of file