From bce3cdeba8bf57226bef4ad506405ca58921d4ea Mon Sep 17 00:00:00 2001 From: Ziming Liu Date: Sun, 28 Apr 2024 20:36:09 -0400 Subject: [PATCH 1/8] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a8b7a26d..e2f99ae8 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,11 @@ pip install -r requirements.txt The documenation can be found here []. ## Tutorials -Jupyter Notebooks in ``docs/Examples`` and ``docs/API_demo`` are ready to play. + +**Quickstart** +Get started with ``hellokan.ipynb`` notebook + +**More demos** +Jupyter Notebooks in ``docs/Examples`` and ``docs/API_demo`` are ready to play. You may also find these examples in documentation. From 26295f4d37ce6ff6506578a84ed086e3774f4391 Mon Sep 17 00:00:00 2001 From: Ziming Liu Date: Sun, 28 Apr 2024 20:36:59 -0400 Subject: [PATCH 2/8] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e2f99ae8..06740df3 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,8 @@ The documenation can be found here []. ## Tutorials **Quickstart** -Get started with ``hellokan.ipynb`` notebook + +Get started with [hellokan.ipynb](./hellokan.ipynb) notebook **More demos** Jupyter Notebooks in ``docs/Examples`` and ``docs/API_demo`` are ready to play. You may also find these examples in documentation. From 48f68bb3e6c7daf44625d5ceb3fe7657ea53a73b Mon Sep 17 00:00:00 2001 From: Ziming Liu Date: Sun, 28 Apr 2024 20:37:53 -0400 Subject: [PATCH 3/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 06740df3..c47544ed 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,6 @@ The documenation can be found here []. Get started with [hellokan.ipynb](./hellokan.ipynb) notebook **More demos** -Jupyter Notebooks in ``docs/Examples`` and ``docs/API_demo`` are ready to play. You may also find these examples in documentation. +Jupyter Notebooks in [docs/Examples](./docs/Examples) and [docs/API_demo]((./docs/API_demo)) are ready to play. You may also find these examples in documentation. From bd03affa6ccf39040dcb0e0f2a8491519859e2ea Mon Sep 17 00:00:00 2001 From: Ziming Liu Date: Sun, 28 Apr 2024 20:38:40 -0400 Subject: [PATCH 4/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c47544ed..04d90fa6 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,6 @@ The documenation can be found here []. Get started with [hellokan.ipynb](./hellokan.ipynb) notebook **More demos** -Jupyter Notebooks in [docs/Examples](./docs/Examples) and [docs/API_demo]((./docs/API_demo)) are ready to play. You may also find these examples in documentation. +Jupyter Notebooks in [docs/Examples](./docs/Examples) and [docs/API_demo]((./docs/API\_demo)) are ready to play. You may also find these examples in documentation. From c31f1dccb3a61ad97c498ef0d281230a7d29ef35 Mon Sep 17 00:00:00 2001 From: Ziming Liu Date: Sun, 28 Apr 2024 20:39:58 -0400 Subject: [PATCH 5/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 04d90fa6..48586280 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,6 @@ The documenation can be found here []. Get started with [hellokan.ipynb](./hellokan.ipynb) notebook **More demos** -Jupyter Notebooks in [docs/Examples](./docs/Examples) and [docs/API_demo]((./docs/API\_demo)) are ready to play. You may also find these examples in documentation. +Jupyter Notebooks in [docs/Examples](./docs/Examples) and [docs/API_demo](./docs/API\_demo) are ready to play. You may also find these examples in documentation. From 3e03cbc01b2c83e50af5bd9ceb87c5250f9caf1d Mon Sep 17 00:00:00 2001 From: Ziming Liu Date: Sun, 28 Apr 2024 20:41:30 -0400 Subject: [PATCH 6/8] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 48586280..77c8ed5f 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ The documenation can be found here []. Get started with [hellokan.ipynb](./hellokan.ipynb) notebook **More demos** + Jupyter Notebooks in [docs/Examples](./docs/Examples) and [docs/API_demo](./docs/API\_demo) are ready to play. You may also find these examples in documentation. From 85edb194a1b4b72bd3d92b67fca94d96fcb40708 Mon Sep 17 00:00:00 2001 From: Ziming Liu Date: Sun, 28 Apr 2024 21:16:06 -0400 Subject: [PATCH 7/8] Create LICENSE --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..2c83bbe2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Ziming Liu + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 8d766b51324c07b961f9b56f1cb048f84f127c47 Mon Sep 17 00:00:00 2001 From: Ziming Liu Date: Sun, 28 Apr 2024 21:50:41 -0400 Subject: [PATCH 8/8] Update requirements.txt --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index cfecb027..3fbbf59f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ matplotlib==3.6.2 moviepy==1.0.3 -numpy==1.26.4 +numpy==1.24.4 scikit_learn==1.1.3 setuptools==65.5.0 sphinx_rtd_theme==2.0.0