Improve adaptation

tongyx361 · Sep 13, 2024 · 7615e2c · 7615e2c
1 parent 7c5b6dc
commit 7615e2c
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,14 @@
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
+## Adaptation Checklist
+
+- [ ] [`nbs/index.ipynb`](nbs/index.ipynb)
+- [ ] [`settings.ini`](settings.ini)
+- [ ] [`environment.yml`](environment.yml)
+- [ ] [`pkg_name` directory](pkg_name)
+- [ ] Run `bash utils/prepare-commit.sh`
+
 ## Setup
 
 We recommend:
@@ -19,14 +27,13 @@ Run the following commands to setup the **basic environment** and
 ``` shell
 git clone https://github.com/tongyx361/nbdev-template-tongyx361.git
 cd nbdev-template-tongyx361
-# Configure settings.ini, environment.yml, pkg_name
 conda env create -f environment.yml
 conda activate myenv
 pip install -r requirements.txt
 ```
 
 For common users/developers, please just run the following command the
-install the `dart-math` package:
+install the `pkg_name` package:
 
 ``` shell
 pip install -e "."

diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -17,6 +17,19 @@
     "# `nbdev` Template @tongyx361\n"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Adaptation Checklist\n",
+    "\n",
+    "- [ ] [`nbs/index.ipynb`](nbs/index.ipynb)\n",
+    "- [ ] [`settings.ini`](settings.ini)\n",
+    "- [ ] [`environment.yml`](environment.yml)\n",
+    "- [ ] [`pkg_name` directory](pkg_name)\n",
+    "- [ ] Run `bash utils/prepare-commit.sh`"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -33,13 +46,12 @@
     "```shell\n",
     "git clone https://github.com/tongyx361/nbdev-template-tongyx361.git\n",
     "cd nbdev-template-tongyx361\n",
-    "# Configure settings.ini, environment.yml, pkg_name\n",
     "conda env create -f environment.yml\n",
     "conda activate myenv\n",
     "pip install -r requirements.txt\n",
     "```\n",
     "\n",
-    "For common users/developers, please just run the following command the install the `dart-math` package:\n",
+    "For common users/developers, please just run the following command the install the `pkg_name` package:\n",
     "\n",
     "```shell\n",
     "pip install -e \".\"\n",