nbdev1 note

Author: jph00

README.md

@@ -3,6 +3,16 @@ Getting started
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
+**NB: This is nbdev v2, a new from-scratch rewrite of nbdev that’s not
+backwards compatible. Whilst the differences to nbdev1 aren’t huge, it
+does require some changes. So if you wish to continue to use nbdev1
+until you’ve got the time to upgrade, you can find the old version docs
+at [nbdev1.fast.ai](https://nbdev1.fast.ai). You can use version-pinning
+in your `requirements.txt` or `settings.ini` (i.e use `'nbdev<2'` as
+your dependency) to stop nbdev from being upgraded.**
+
+------------------------------------------------------------------------
+
 `nbdev` is a system for *exploratory programming*. Simply write
 notebooks with lightweight markup and get high-quality documentation,
 tests, continuous integration, and packaging for free!

nbs/getting_started.ipynb

@@ -13,6 +13,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "**NB: This is nbdev v2, a new from-scratch rewrite of nbdev that's not backwards compatible. Whilst the differences to nbdev1 aren't huge, it does require some changes. So if you wish to continue to use nbdev1 until you've got the time to upgrade, you can find the old version docs at [nbdev1.fast.ai](https://nbdev1.fast.ai). You can use version-pinning in your `requirements.txt` or `settings.ini` (i.e use `'nbdev<2'` as your dependency) to stop nbdev from being upgraded.**\n",
+    "\n",
+    "---\n",
+    "\n",
     "`nbdev` is a system for *exploratory programming*.  Simply write notebooks with lightweight markup and get high-quality documentation, tests, continuous integration, and packaging for free!\n",
     "\n",
     "`nbdev` makes debugging and refactoring your code much easier than in traditional programming environments since you always have live objects at your fingertips.  `nbdev` also promotes software engineering best practices because tests and documentation are first class."
@@ -203,7 +207,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3.9.13 64-bit",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   }