Add a note on nbclassic

ConGustoAI · Jul 23, 2024 · ff5a94c · ff5a94c
1 parent ffec2af
commit ff5a94c
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,18 @@
 pip install friendlly
 ```
 
+## ⚠️ At least for now, FriendLLy only works in Jupyter nbclassic!
+
+Due to tight intergration with the front-end, only `jupyter nbclassic`
+(aka jupyter 6) is supported initially. You can install it alongside
+`jupyter notebook` or `juter lab` without causing any conflicts
+
+    pip install nbclassic
+
+And rut it with
+
+    jupyter nbclassic
+
 ## How to use
 
 ``` python

diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -34,6 +34,23 @@
     "```"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## ⚠️ At least for now, FriendLLy only works in Jupyter nbclassic!\n",
+    "\n",
+    "Due to tight intergration with the front-end, only `jupyter nbclassic` (aka jupyter 6) is supported initially.\n",
+    "You can install it alongside `jupyter notebook` or `juter lab` without causing any conflicts \n",
+    "```\n",
+    "pip install nbclassic\n",
+    "```\n",
+    "And rut it with\n",
+    "```\n",
+    "jupyter nbclassic\n",
+    "```\n"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},