From 0a44dbddb57095604a5c0972fe331114946f513e Mon Sep 17 00:00:00 2001 From: Philip Zucker Date: Tue, 21 Jan 2025 11:09:58 -0500 Subject: [PATCH] tutorial update --- tutorial.ipynb | 41 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/tutorial.ipynb b/tutorial.ipynb index 34b51a6..6afb8e2 100644 --- a/tutorial.ipynb +++ b/tutorial.ipynb @@ -9,7 +9,9 @@ "This tutorial can be used online at \n", "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](http://colab.research.google.com/github/philzook58/knuckledragger/blob/main/tutorial.ipynb)\n", "\n", - "Running the following cell will install Knuckledragger on your collab instance." + "The documentation for knuckledragger is available [here](https://www.philipzucker.com/knuckledragger/)\n", + "\n", + "Running the following cell will install Knuckledragger on your colab instance." ] }, { @@ -24,8 +26,41 @@ "source": [ "%%bash\n", "git clone https://github.com/philzook58/knuckledragger.git\n", - "cd knuckledragger\n", - "python3 -m pip install -e ." + "cd knuckledragger" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": { + "tags": [ + "test_skip" + ] + }, + "outputs": [], + "source": [ + "!python3 -m pip install -e ." + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "You may need to restart your colab instance to get the installation to take. You can do so in the menu or by running the following cell." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": { + "tags": [ + "test_skip" + ] + }, + "outputs": [], + "source": [ + "import os\n", + "os.kill(os.getpid(), 9)" ] }, {