update readme

sky1ove · Oct 31, 2024 · 397c254 · 397c254
1 parent 057f956
commit 397c254
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -12,4 +12,12 @@ To run notebooks successfully, install `dev` version of python-katlas:
 
     pip install 'python-katlas[dev]' -U
 
-## Go to `nbs` folder to run notebooks
+## Instruction
+
+After installation, go to `nbs` folder to run notebooks
+
+## Doc site for this repository
+
+Notebooks in the nbs folder can be visualized at:
+
+https://sky1ove.github.io/katlas_raw/
diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -36,7 +36,30 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Go to `nbs` folder to run notebooks"
+    "## Instruction"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "After installation, go to `nbs` folder to run notebooks"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Doc site for this repository"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Notebooks in the nbs folder can be visualized at: \n",
+    "\n",
+    "https://sky1ove.github.io/katlas_raw/"
    ]
   }
  ],