fixes #690

Author: jph00

nbs/tutorial.ipynb

@@ -87,7 +87,7 @@
     "Jupyter notebook has a terminal window available, so we'll use that:\n",
     "1. Start `jupyter notebook`\n",
     "2. From the \"New\" dropdown on the right side, choose `Terminal`.\n",
-    "3. Enter \"`python -m pip install nbdev`\" (or use conda as specified above)\n",
+    "3. Enter \"`pip install nbdev`\" (or use conda as specified above)\n",
     "\n",
     "When the command completes, you're ready to go."
    ]
@@ -112,7 +112,9 @@
    "source": [
     "To create your new project repo, use the cli command `nbdev_new` to **create a new nbdev project from an existing GitHub repo that you have cloned locally.**  _To create a new GitHub repo locally, we recommend the [gh cli](https://cli.github.com/) tool, which allows you to create a new repo with the command `gh repo create`._\n",
     "\n",
-    "Alternatively, you can create a new empty github repository using [this link](https://github.com/new), and follow the instructions on github to clone the repository locally before running the command `nbdev_new`"
+    "Alternatively, you can create a new empty github repository using [this link](https://github.com/new), and follow the instructions on github to clone the repository locally before running the command `nbdev_new`.\n",
+    "\n",
+    "In GitHub, click the settings cog in the top right of the repo page (next to \"**About**\") and fill in the description and tags, since nbdev will use these automatically."
    ]
   },
   {
@@ -151,27 +153,6 @@
     "Next, edit the `settings.ini` file in your cloned repo. This file contains all the necessary information for when you'll be ready to package your library. The basic structure (that can be personalized provided you change the relevant information in `settings.ini`) is that the root of the repo will contain your notebooks, the `docs` folder will contain your auto-generated docs, and a folder with a name you select will contain your auto-generated modules."
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You'll see these commented out lines in `settings.ini`. Uncomment them, and set each value as needed.\n",
-    "\n",
-    "```\n",
-    "# lib_name = your_project_name\n",
-    "# repo_name = name of github repo\n",
-    "# user = your_github_username\n",
-    "# description = A description of your project\n",
-    "# keywords = some keywords\n",
-    "# author = Your Name\n",
-    "# author_email = [email protected]\n",
-    "# copyright = Your Name or Company Name\n",
-    "# branch = The default branch of your GitHub repo (usually either master or main)\n",
-    "```\n",
-    "\n",
-    "We'll see some other settings we can change later."
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -327,7 +308,9 @@
    "outputs": [
     {
      "data": {
-      "image/svg+xml": "<svg height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\"/></svg>",
+      "image/svg+xml": [
+       "<svg height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\"/></svg>"
+      ],
       "text/plain": [
        "<IPython.core.display.SVG object>"
       ]
@@ -1040,9 +1023,34 @@
    "split_at_heading": true
   },
   "kernelspec": {
-   "display_name": "Python 3.9.13 64-bit",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.13"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": false,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
   }
  },
  "nbformat": 4,

settings.ini

@@ -16,7 +16,7 @@ language = English
 custom_sidebar = True
 license = apache2
 status = 2
-requirements = fastcore>=1.5.8 execnb astunparse
+requirements = fastcore>=1.5.8 execnb astunparse ghapi
 dev_requirements = nbdev-numpy
 	nbdev-stdlib
 	pandas