[All] Update infos around new organization and new licenses.

Meloland · Apr 17, 2024 · 85262e2 · 85262e2
1 parent 9998101
commit 85262e2
Show file tree

Hide file tree

Showing 5 changed files with 109 additions and 55 deletions.
diff --git a/.github/workflows/mkdoc.yml b/.github/workflows/mkdoc.yml
@@ -26,7 +26,7 @@ jobs:
 
     - name: Commit doc changes
       run: |
-        git clone https://github.com/aicorein/melobot.git --branch gh-pages --single-branch gh-pages
+        git clone https://github.com/Meloland/melobot.git --branch gh-pages --single-branch gh-pages
         mkdir tmp-files && cd gh-pages
         mv CNAME .nojekyll README.md .git ../tmp-files
         rm -rf * && rm .buildinfo && cd ..

diff --git a/LICENSE-CC b/LICENSE-CC
@@ -1,4 +1,4 @@
-Attribution 4.0 International
+Attribution-ShareAlike 4.0 International
 
 =======================================================================
 
@@ -54,16 +54,18 @@ exhaustive, and do not form part of our licenses.
 
 =======================================================================
 
-Creative Commons Attribution 4.0 International Public License
+Creative Commons Attribution-ShareAlike 4.0 International Public
+License
 
 By exercising the Licensed Rights (defined below), You accept and agree
 to be bound by the terms and conditions of this Creative Commons
-Attribution 4.0 International Public License ("Public License"). To the
-extent this Public License may be interpreted as a contract, You are
-granted the Licensed Rights in consideration of Your acceptance of
-these terms and conditions, and the Licensor grants You such rights in
-consideration of benefits the Licensor receives from making the
-Licensed Material available under these terms and conditions.
+Attribution-ShareAlike 4.0 International Public License ("Public
+License"). To the extent this Public License may be interpreted as a
+contract, You are granted the Licensed Rights in consideration of Your
+acceptance of these terms and conditions, and the Licensor grants You
+such rights in consideration of benefits the Licensor receives from
+making the Licensed Material available under these terms and
+conditions.
 
 
 Section 1 -- Definitions.
@@ -82,51 +84,59 @@ Section 1 -- Definitions.
      and Similar Rights in Your contributions to Adapted Material in
      accordance with the terms and conditions of this Public License.
 
-  c. Copyright and Similar Rights means copyright and/or similar rights
+  c. BY-SA Compatible License means a license listed at
+     creativecommons.org/compatiblelicenses, approved by Creative
+     Commons as essentially the equivalent of this Public License.
+
+  d. Copyright and Similar Rights means copyright and/or similar rights
      closely related to copyright including, without limitation,
      performance, broadcast, sound recording, and Sui Generis Database
      Rights, without regard to how the rights are labeled or
      categorized. For purposes of this Public License, the rights
      specified in Section 2(b)(1)-(2) are not Copyright and Similar
      Rights.
 
-  d. Effective Technological Measures means those measures that, in the
+  e. Effective Technological Measures means those measures that, in the
      absence of proper authority, may not be circumvented under laws
      fulfilling obligations under Article 11 of the WIPO Copyright
      Treaty adopted on December 20, 1996, and/or similar international
      agreements.
 
-  e. Exceptions and Limitations means fair use, fair dealing, and/or
+  f. Exceptions and Limitations means fair use, fair dealing, and/or
      any other exception or limitation to Copyright and Similar Rights
      that applies to Your use of the Licensed Material.
 
-  f. Licensed Material means the artistic or literary work, database,
+  g. License Elements means the license attributes listed in the name
+     of a Creative Commons Public License. The License Elements of this
+     Public License are Attribution and ShareAlike.
+
+  h. Licensed Material means the artistic or literary work, database,
      or other material to which the Licensor applied this Public
      License.
 
-  g. Licensed Rights means the rights granted to You subject to the
+  i. Licensed Rights means the rights granted to You subject to the
      terms and conditions of this Public License, which are limited to
      all Copyright and Similar Rights that apply to Your use of the
      Licensed Material and that the Licensor has authority to license.
 
-  h. Licensor means the individual(s) or entity(ies) granting rights
+  j. Licensor means the individual(s) or entity(ies) granting rights
      under this Public License.
 
-  i. Share means to provide material to the public by any means or
+  k. Share means to provide material to the public by any means or
      process that requires permission under the Licensed Rights, such
      as reproduction, public display, public performance, distribution,
      dissemination, communication, or importation, and to make material
      available to the public including in ways that members of the
      public may access the material from a place and at a time
      individually chosen by them.
 
-  j. Sui Generis Database Rights means rights other than copyright
+  l. Sui Generis Database Rights means rights other than copyright
      resulting from Directive 96/9/EC of the European Parliament and of
      the Council of 11 March 1996 on the legal protection of databases,
      as amended and/or succeeded, as well as other essentially
      equivalent rights anywhere in the world.
 
-  k. You means the individual or entity exercising the Licensed Rights
+  m. You means the individual or entity exercising the Licensed Rights
      under this Public License. Your has a corresponding meaning.
 
 
@@ -172,7 +182,13 @@ Section 2 -- Scope.
                Licensed Rights under the terms and conditions of this
                Public License.
 
-            b. No downstream restrictions. You may not offer or impose
+            b. Additional offer from the Licensor -- Adapted Material.
+               Every recipient of Adapted Material from You
+               automatically receives an offer from the Licensor to
+               exercise the Licensed Rights in the Adapted Material
+               under the conditions of the Adapter's License You apply.
+
+            c. No downstream restrictions. You may not offer or impose
                any additional or different terms or conditions on, or
                apply any Effective Technological Measures to, the
                Licensed Material if doing so restricts exercise of the
@@ -254,9 +270,24 @@ following conditions.
           information required by Section 3(a)(1)(A) to the extent
           reasonably practicable.
 
-       4. If You Share Adapted Material You produce, the Adapter's
-          License You apply must not prevent recipients of the Adapted
-          Material from complying with this Public License.
+  b. ShareAlike.
+
+     In addition to the conditions in Section 3(a), if You Share
+     Adapted Material You produce, the following conditions also apply.
+
+       1. The Adapter's License You apply must be a Creative Commons
+          license with the same License Elements, this version or
+          later, or a BY-SA Compatible License.
+
+       2. You must include the text of, or the URI or hyperlink to, the
+          Adapter's License You apply. You may satisfy this condition
+          in any reasonable manner based on the medium, means, and
+          context in which You Share Adapted Material.
+
+       3. You may not offer or impose any additional or different terms
+          or conditions on, or apply any Effective Technological
+          Measures to, Adapted Material that restrict exercise of the
+          rights granted under the Adapter's License You apply.
 
 
 Section 4 -- Sui Generis Database Rights.
@@ -271,7 +302,8 @@ apply to Your use of the Licensed Material:
   b. if You include all or a substantial portion of the database
      contents in a database in which You have Sui Generis Database
      Rights, then the database in which You have Sui Generis Database
-     Rights (but not its individual contents) is Adapted Material; and
+     Rights (but not its individual contents) is Adapted Material,
+     including for purposes of Section 3(b); and
 
   c. You must comply with the conditions in Section 3(a) if You Share
      all or a substantial portion of the contents of the database.

diff --git a/README.md b/README.md
@@ -1,14 +1,15 @@
 <div align="center">
-  <img width=200 src="https://github.com/aicorein/melobot/blob/main/docs/source/_static/logo.png?raw=true" />
-  <h1>MeloBot</h1>
+  <img width=200 src="https://github.com/Meloland/melobot/blob/main/docs/source/_static/logo.png?raw=true" />
+  <h1>melobot</h1>
   <p>
-    <strong>插件化管理、基于异步会话机制的 qq 机器人开发框架</strong>
+    <strong>插件化管理、基于异步会话机制的机器人开发框架</strong>
   </p>
   <p align="center">
-    <a href="https://raw.githubusercontent.com/aicorein/melobot/main/LICENSE"><img src="https://img.shields.io/github/license/aicorein/melobot" alt="license"></a>
-    <a href="https://docs.melobot.org/"><img src="https://img.shields.io/badge/doc-latest-blue.svg" alt="MeloBot docs"></a>
-    <a href="https://github.com/aicorein/melobot"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/aicorein/melobot"></a>
-    <a href="https://github.com/howmanybots/onebot/blob/master/README.md"><img src="https://img.shields.io/badge/OneBot-v11-blue?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABABAMAAABYR2ztAAAAIVBMVEUAAAAAAAADAwMHBwceHh4UFBQNDQ0ZGRkoKCgvLy8iIiLWSdWYAAAAAXRSTlMAQObYZgAAAQVJREFUSMftlM0RgjAQhV+0ATYK6i1Xb+iMd0qgBEqgBEuwBOxU2QDKsjvojQPvkJ/ZL5sXkgWrFirK4MibYUdE3OR2nEpuKz1/q8CdNxNQgthZCXYVLjyoDQftaKuniHHWRnPh2GCUetR2/9HsMAXyUT4/3UHwtQT2AggSCGKeSAsFnxBIOuAggdh3AKTL7pDuCyABcMb0aQP7aM4AnAbc/wHwA5D2wDHTTe56gIIOUA/4YYV2e1sg713PXdZJAuncdZMAGkAukU9OAn40O849+0ornPwT93rphWF0mgAbauUrEOthlX8Zu7P5A6kZyKCJy75hhw1Mgr9RAUvX7A3csGqZegEdniCx30c3agAAAABJRU5ErkJggg==" alt="cqhttp"></a>
+    <a href="https://github.com/Meloland/melobot/tree/main/LICENSE-BSD"><img src="https://img.shields.io/badge/license-BSD--3--Clause-2ea44f" alt="license - BSD-3-Clause"></a>
+    <a href="https://github.com/Meloland/melobot/tree/main/LICENSE-CC"><img src="https://img.shields.io/badge/license-CC--BY--SA--4.0-2ea44f" alt="license - CC-BY-SA-4.0"></a>
+    <a href="https://docs.melobot.org/"><img src="https://img.shields.io/badge/doc-latest-blue.svg" alt="melobot docs"></a>
+    <a href="https://github.com/Meloland/melobot"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/Meloland/melobot"></a>
+    <a href="https://github.com/botuniverse/onebot-11"><img src="https://img.shields.io/badge/OneBot-v11-blue?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABABAMAAABYR2ztAAAAIVBMVEUAAAAAAAADAwMHBwceHh4UFBQNDQ0ZGRkoKCgvLy8iIiLWSdWYAAAAAXRSTlMAQObYZgAAAQVJREFUSMftlM0RgjAQhV+0ATYK6i1Xb+iMd0qgBEqgBEuwBOxU2QDKsjvojQPvkJ/ZL5sXkgWrFirK4MibYUdE3OR2nEpuKz1/q8CdNxNQgthZCXYVLjyoDQftaKuniHHWRnPh2GCUetR2/9HsMAXyUT4/3UHwtQT2AggSCGKeSAsFnxBIOuAggdh3AKTL7pDuCyABcMb0aQP7aM4AnAbc/wHwA5D2wDHTTe56gIIOUA/4YYV2e1sg713PXdZJAuncdZMAGkAukU9OAn40O849+0ornPwT93rphWF0mgAbauUrEOthlX8Zu7P5A6kZyKCJy75hhw1Mgr9RAUvX7A3csGqZegEdniCx30c3agAAAABJRU5ErkJggg==" alt="cqhttp"></a>
   </p>
   <p align="center">
     <a href="https://python.org" title="Go to Python homepage"><img src="https://img.shields.io/badge/Python-%3E=3.10-green?logo=python&logoColor=white" alt="Made with Python"></a>
@@ -27,23 +28,30 @@
 
 ## 🎉 简介
 
-MeloBot 是一个基于 Python 的 qq 机器人开发框架。其以**Onebot 标准的实现项目**作为前端，通过对来自“前端”的各种“事件”的处理，再产生“行为”，最后提交给“前端”与 qq 服务器交互，即可实现各类复杂的功能。
+melobot 是基于 Python 的机器人开发框架。目前开发版本号为 v2，只适用于搭建 qq 机器人。v2 版本以**Onebot 标准的实现项目**作为前端，通过对来自“前端”的各种“事件”的处理，产生“行为”，最后提交给“前端”与 qq 服务器交互，从而实现各种复杂的功能。
+
+v3 是 melobot 的下一版本，目前仍在开发中。v3 计划支持多协议以扩展至各种平台提供机器人服务。
+
+## ✨ 特色
+
+- 高性能异步：基于 asyncio，但使用性能更优秀的事件循环策略：[uvloop](https://github.com/MagicStack/uvloop)/[winloop](https://github.com/Vizonex/Winloop)
+- 插件管理：更低耦合度的插件加载、通信模式
+- 会话控制：自动传递上下文（会话）、可自定义的会话
+- 流程与生命周期：支持事件预检查、预匹配和预解析；支持添加生命周期 hook
+- 多实例协同：多 bot 实例运行，跨实例通信
+- 异步接口：封装了部分常用的异步控制流
 
 使用本框架的机器人项目如下：
 
 - [MeloInf](https://github.com/aicorein/meloinf)
 
-你可以将这些项目作为 melobot 的使用参考之一。我们也欢迎你基于 melobot 实现机器人后，向文档提出 PR，在此处展示。
+你可以将这些项目作为 melobot 使用的实例参考。欢迎你基于 melobot 实现完整的机器人项目后，向本文档提出 PR，在此处展示。
 
-## ✨ 特色
+## 💬 文档
+
+项目文档：[melobot 文档](https://docs.melobot.org)
 
-- 基于 asyncio 的高性能异步
-- 支持插件交互的插件化管理
-- 异步会话控制、自动的会话上下文
-- 事件预检查、预匹配和预解析
-- 支持 bot 生命周期 hook
-- 支持多 bot 协同工作
-- 丰富的接口设计
+对于文档可能出现的纰漏，恳请各位包涵。欢迎提出修正和优化文档的 PR：[文档源文件](https://github.com/Meloland/melobot/tree/main/docs/source)
 
 ## 📦️ 安装使用
 
@@ -63,20 +71,33 @@ pdm install
 pdm build
 ```
 
-之后可在 `.pdm-build` 目录获取本地构建，pip 本地安装即可。
+之后可在 `.pdm-build` 目录获取本地构建，pip 本地安装即可。提示：首次运行 pdm 需要初始化虚拟环境，请参照 pdm 文档操作。
 
-提示：首次运行 pdm 需要初始化虚拟环境，可参照 pdm 文档操作。
+## 🪄 版本特性
 
-## 🪄 版本支持
+- python 版本需要 `>=3.10`
+- 可跨平台使用
+- 通信标准：[OneBot v11](https://github.com/botuniverse/onebot-11)
 
-- python >= 3.10
-- platform == All
-- OneBot 标准 == 11
+<!-- end elevator-pitch -->
 
-## 💬 更多
+## 📜 开源许可证
 
-项目文档：[MeloBot 文档](https://docs.melobot.org)
+本项目使用双许可证。
 
-对于文档可能出现的纰漏，还请各位包涵。欢迎提出修正和优化文档的 PR：[文档源文件](https://github.com/aicorein/melobot/tree/main/docs/source)
+[docs](https://github.com/Meloland/melobot/tree/main/docs) 目录内所有内容在 CC-BY-SA-4.0 许可下发行。
+
+<a href="http://creativecommons.org/licenses/by-sa/4.0/" rel="nofollow"><img src="https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-sa.svg" style="width: 150px"></a>
+
+此部分版权主体为：
+
+> **melobot 文档的所有贡献者**
+
+[docs](https://github.com/Meloland/melobot/tree/main/docs) 目录外所有内容在 BSD 3-Clause 许可下发行。
+
+<a href="https://opensource.org/license/bsd-3-clause"><img src="https://upload.wikimedia.org/wikipedia/commons/d/d5/License_icon-bsd-88x31.svg" style="width: 150px"></a>
+
+此部分版权主体为：
+
+> **melobot 项目的所有贡献者（此处不包含只对文档有贡献的）**
 
-<!-- end elevator-pitch -->
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,3 +1,4 @@
+import datetime
 import inspect
 import os
 import sys
@@ -16,8 +17,8 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "MeloBot"
-copyright = "2024, aicorein"
-author = "aicorein"
+author = "contributors of this doc"
+copyright = f"{datetime.date.today().year}, {author}"
 release = "2.5.13"
 
 # -- General configuration ---------------------------------------------------
@@ -58,11 +59,11 @@
 html_logo = "logo.png"
 html_theme = "furo"
 html_theme_options = {
-    "source_edit_link": "https://github.com/aicorein/melobot/tree/main/docs/source/{filename}",
+    "source_edit_link": "https://github.com/Meloland/melobot/tree/main/docs/source/{filename}",
     "footer_icons": [
         {
             "name": "GitHub",
-            "url": "https://github.com/aicorein/melobot",
+            "url": "https://github.com/Meloland/melobot",
             "html": """
                 <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
                     <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>

diff --git a/pyproject.toml b/pyproject.toml
@@ -20,7 +20,7 @@ readme = "README.md"
 license = {text = "AGPL3"}
 
 [project.urls]
-Homepage = "https://github.com/aicorein/melobot"
+Homepage = "https://github.com/Meloland/melobot"
 
 [build-system]
 requires = ["pdm-backend"]