├── contributing.md ├── README_CN.md ├── README.md ├── LICENSE └── .gitignore /contributing.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | When contributing to the RK3588 project, please ensure that you adhere to the following guidelines: 4 | 5 | - The pull request should have a useful title and include a link to the thing you're submitting and why it should be included. 6 | - Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. 7 | - If you just created something, wait at least 30 days before submitting. 8 | - The project repo should have at least 20 stars. 9 | - Search previous suggestions before making a new one, as yours may be a duplicate. 10 | - Boilerplates are not accepted as most boilerplates are too opinionated and low-quality and I don't have time to comment on everything they need to improve. 11 | - If you're submitting a closed source app, include evidence of it being built with RK3588. 12 | - The "Closed Source" section has a very high bar for acceptance. You're a lot more likely to get accepted if you link to a blog post on how you built the app. Don't worry if your submission is declined, you can still submit your app to the official RK3588 apps list. 13 | - Make an individual pull request for each suggestion. 14 | - Use the following format: `[title](link) - Description.` 15 | - Descriptions should be short and simple, but descriptive. 16 | - Start the description with a capital and end with a full stop/period. 17 | - Don't mention RK3588 in the description as it's implied. 18 | - Don't start the description with A or An. 19 | - Check your spelling and grammar. 20 | - Make sure your text editor is set to remove trailing whitespace. 21 | - New categories or improvements to the existing categorization are welcome, but should be done in a separate pull request. 22 | - Thank you for your suggestion! 23 | 24 | **Updating your PR** 25 | A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. If you're not sure how to do that, [here ↗](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) is a guide on the different ways you can update your PR so that we can merge it. -------------------------------------------------------------------------------- /README_CN.md: -------------------------------------------------------------------------------- 1 | [English](README.md) | 简体中文 2 | 3 | # Awesome RK3588 | [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) 4 | 5 | [](https://www.rock-chips.com/) 6 | 7 | RK3588是瑞芯微旗舰级8K SoC芯片，配备四核Cortex-A76、四核Cortex-A55及6 TOPS NPU。本列表整理了开发必备资源。:rocket: 8 | 9 | ## 目录 10 | - [官方资源](#官方资源) 11 | - [RKNN与AI工具](#rknn与ai工具) 12 | - [大语言模型](#大语言模型) 13 | - [操作系统](#操作系统) 14 | - [项目](#项目) 15 | - [开发板](#开发板) 16 | - [文档](#文档) 17 | - [开发工具](#开发工具) 18 | - [示例代码](#示例代码) 19 | - [社区](#社区) 20 | 21 | ## 官方资源 22 | 1. [Rockchip Linux ↗](https://github.com/rockchip-linux) - 官方内核、u-boot、MPP 23 | 2. [RKNN SDK文档 ↗](https://github.com/airockchip/rknn-toolkit2/tree/master/doc) - 最新SDK指南 24 | 3. [RKNPU2教程 ↗](https://www.bilibili.com/video/BV1Kj411D78q) - RKNPU2从入门到实践 25 | 4. [瑞芯微资源门户 ↗](https://console.zbox.filez.com/l/I00fc3) - SDK下载（提取码：rknn） 26 | 27 | ## RKNN与AI工具 28 | ### 核心SDK 29 | 1. **[RKNN-Toolkit2 ↗](https://github.com/airockchip/rknn-toolkit2)** - 模型转换与评估（v2.3.2+） 30 | 2. **[RKNPU2 Runtime ↗](https://github.com/rockchip-linux/rknpu2)** - NPU运行时库 31 | 3. **[RKNN-Toolkit-Lite2 ↗](https://github.com/airockchip/rknn-toolkit2/tree/master/rknn-toolkit-lite2)** - 设备端Python API 32 | 4. **[librga ↗](https://github.com/airockchip/librga)** - 2D图形加速库 33 | 34 | ### 模型库 35 | 1. **[RKNN Model Zoo ↗](https://github.com/airockchip/rknn_model_zoo)** - 30+预训练模型（YOLO11、SAM、Whisper、CLIP） 36 | 2. **[RKLLM ↗](https://github.com/airockchip/rknn-llm)** - 大语言模型部署栈 37 | 38 | ## 大语言模型 39 | *RK3588支持边缘LLM部署，需使用RKLLM栈* 40 | 1. **支持模型**：TinyLlama 1.1B（约10-15 token/秒）、Qwen2 0.5B、Whisper 41 | 2. **[RKLLM Toolkit ↗](https://github.com/airockchip/rknn-llm)** - LLM转换与部署工具 42 | 43 | ## 操作系统 44 | 1. **[Ubuntu Rockchip ↗](https://github.com/Joshua-Riek/ubuntu-rockchip)** - Ubuntu 22.04/24.04 LTS（推荐） 45 | 2. **[Armbian ↗](https://www.armbian.com/)** - 官方RK3588支持 46 | 3. **[Buildroot RK3588 ↗](https://github.com/Military-Vehicle-Detection/buildroot-rk3588)** - 极简Buildroot 47 | 4. **[NixOS RK3588 ↗](https://github.com/ryan4yin/nixos-rk3588)** - 适用于香橙派/ROCK 5A的NixOS 48 | 49 | ## 项目 50 | 1. **[YOLOv8 C++ ↗](https://github.com/cqu20160901/yolov8_rknn_Cplusplus)** - 生产级YOLOv8推理 51 | 2. **[rknn-multi-threaded ↗](https://github.com/leafqycc/rknn-multi-threaded)** - 多线程NPU（性能+40%） 52 | 3. **[YOLOv5+DeepSORT ↗](https://github.com/Zhou-sx/yolov5_Deepsort_rknn)** - 实时目标跟踪 53 | 4. **[GStreamer MPP ↗](https://github.com/rockchip-linux/gstreamer-rockchip)** - 硬件加速视频管线 54 | 5. **[FFmpeg RKMPP ↗](https://github.com/rockchip-linux/ffmpeg-rockchip)** - 8K视频编解码 55 | 56 | ## 开发板 57 | ### 消费级/创客 58 | 1. **[香橙派5系列 ↗](http://www.orangepi.org/)** - 性价比最高（4-16GB，PCIe 3.0） 59 | 2. **[Radxa ROCK 5 ↗](https://radxa.com/products/rock5)** - 工业级，双网口 60 | 3. **[野火LubanCat RK3588 ↗](https://doc.embedfire.com/products/link/zh/latest/linux/ebf_lubancat.html)** - 接口丰富，中文文档完善 61 | 62 | ### 工业级 63 | 1. **ITOP-3588 ↗** - 北京迅为，完整技术支持 64 | 2. **FireFly ITX-3588J ↗** - Mini-ITX嵌入式版型 65 | 66 | ## 文档 67 | ### 技术文档 68 | 1. **[RK3588数据手册 ↗](https://www.rock-chips.com/uploads/pdf/2022.8.26/191/RK3588%20Brief%20Datasheet.pdf)** - 官方规格（6 TOPS，8K@60fps） 69 | 2. **[RKNN用户指南 ↗](https://github.com/airockchip/rknn-toolkit2/tree/master/doc)** - 转换与部署指南 70 | 3. **[RKNPU2 API参考 ↗](https://github.com/rockchip-linux/rknpu2/blob/master/doc/Rockchip_RKNPU_User_Guide_RKNN_API_V2.0.0.pdf)** - C/C++ API文档 71 | 72 | ### 开发板专用 73 | 1. **[Radxa ROCK 5文档 ↗](https://docs.radxa.com/rock5)** - 优质英文文档 74 | 2. **[野火LubanCat手册 ↗](https://doc.embedfire.com/linux/rk3588/quick_start/zh/latest/)** - 最佳中文文档 75 | 76 | ## 开发工具 77 | 1. **[RKDevTool ↗](https://github.com/rockchip-linux/rkdeveloptool)** - 固件烧录工具 78 | 2. **[RKNN-Toolkit2 Docker ↗](https://github.com/airockchip/rknn-toolkit2/tree/master/docker)** - 预配置环境 79 | 3. **NPU监控**: `cat /sys/kernel/debug/rknpu/load` 80 | 81 | ## 示例代码 82 | 1. **[RKNN Model Zoo ↗](https://github.com/airockchip/rknn_model_zoo)** - 30+官方模型示例 83 | 2. **[rknn_api_demo ↗](https://github.com/rockchip-linux/rknpu2/tree/master/rknn_api_demo)** - 极简C API示例 84 | 3. **[RKLLM Examples ↗](https://github.com/airockchip/rknn-llm/tree/main/examples)** - LLM聊天机器人示例 85 | 86 | ## 社区 87 | ### 国际社区 88 | 1. **[Radxa论坛 ↗](https://forum.radxa.com/)** - ROCK系列社区 89 | 2. **[Armbian论坛 ↗](https://forum.armbian.com/forum/29-rockchip-3588-3566-3568-3399/)** - 操作系统级支持 90 | 3. **[香橙派论坛 ↗](http://www.orangepi.org/orangepibbsen/)** - 官方香橙派论坛 91 | 92 | ### 中文社区 93 | 1. **[iTOP-RK3588论坛 ↗](http://bbs.topeetboard.com/forum.php?mod=forumdisplay&fid=55)** - 北京迅为技术支持 94 | 2. **[野火LubanCat社区 ↗](https://forums.embedfire.com/c/lubancat/21)** - 野火电子 95 | 96 | --- 97 | 98 | ## 贡献 🤝 99 | 100 | 有提交请求吗？打开它，我们将尽快审查。如果您有任何建议或发现任何错误，请随时提出您的新想法！[贡献指南](contributing.md) 101 | 102 | - [Open Issues](https://github.com/choushunn/awesome-RK3588/issues) 103 | - [Open Pull Requests](https://github.com/choushunn/awesome-RK3588/pulls) 104 | - [Open Discussions](https://github.com/choushunn/awesome-RK3588/discussions) 105 | 106 | 感谢所有代码贡献者。 [[Contribute](contributing.md)]. 107 | 108 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | English | [简体中文](README_CN.md) 2 | 3 | # Awesome RK3588 | [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) 4 | 5 | [](https://www.rock-chips.com/) 6 | 7 | RK3588 is Rockchip's flagship 8K SoC with quad Cortex-A76, quad Cortex-A55, and 6 TOPS NPU. This list curates essential development resources. :rocket: 8 | 9 | ## Contents 10 | - [Official Resources](#official-resources) 11 | - [RKNN & AI Tools](#rknn--ai-tools) 12 | - [Large Language Models](#large-language-models) 13 | - [Operating Systems](#operating-systems) 14 | - [Projects](#projects) 15 | - [Development Boards](#development-boards) 16 | - [Documentation](#documentation) 17 | - [Development Tools](#development-tools) 18 | - [Sample Code](#sample-code) 19 | - [Community](#community) 20 | 21 | ## Official Resources 22 | 1. [Rockchip Linux ↗](https://github.com/rockchip-linux) - Official kernel, u-boot, MPP 23 | 2. [RKNN SDK Documentation ↗](https://github.com/airockchip/rknn-toolkit2/tree/master/doc) - Latest SDK guides 24 | 3. [RKNPU2 Tutorial ↗](https://www.bilibili.com/video/BV1Kj411D78q) - RKNPU2 from entry to practice 25 | 4. [Rockchip Resource Portal ↗](https://console.zbox.filez.com/l/I00fc3) - SDK downloads (code: rknn) 26 | 27 | ## RKNN & AI Tools 28 | ### Core SDK 29 | 1. **[RKNN-Toolkit2 ↗](https://github.com/airockchip/rknn-toolkit2)** - Model conversion & evaluation (v2.3.2+) 30 | 2. **[RKNPU2 Runtime ↗](https://github.com/rockchip-linux/rknpu2)** - NPU runtime libraries 31 | 3. **[RKNN-Toolkit-Lite2 ↗](https://github.com/airockchip/rknn-toolkit2/tree/master/rknn-toolkit-lite2)** - On-device Python API 32 | 4. **[librga ↗](https://github.com/airockchip/librga)** - 2D graphics acceleration 33 | 34 | ### Model Zoo 35 | 1. **[RKNN Model Zoo ↗](https://github.com/airockchip/rknn_model_zoo)** - 30+ pre-trained models (YOLO11, SAM, Whisper, CLIP) 36 | 2. **[RKLLM ↗](https://github.com/airockchip/rknn-llm)** - LLM deployment stack 37 | 38 | ## Large Language Models 39 | *RK3588 supports edge LLM deployment with RKLLM* 40 | 1. **Supported Models**: TinyLlama 1.1B (~10-15 tokens/sec), Qwen2 0.5B, Whisper 41 | 2. **[RKLLM Toolkit ↗](https://github.com/airockchip/rknn-llm)** - Convert and deploy LLMs 42 | 43 | ## Operating Systems 44 | 1. **[Ubuntu Rockchip ↗](https://github.com/Joshua-Riek/ubuntu-rockchip)** - Ubuntu 22.04/24.04 LTS (recommended) 45 | 2. **[Armbian ↗](https://www.armbian.com/)** - Official RK3588 support 46 | 3. **[Buildroot RK3588 ↗](https://github.com/Military-Vehicle-Detection/buildroot-rk3588)** - Minimal Buildroot 47 | 4. **[NixOS RK3588 ↗](https://github.com/ryan4yin/nixos-rk3588)** - NixOS for Orange Pi/ROCK 5A 48 | 49 | ## Projects 50 | 1. **[YOLOv8 C++ ↗](https://github.com/cqu20160901/yolov8_rknn_Cplusplus)** - Production YOLOv8 inference 51 | 2. **[rknn-multi-threaded ↗](https://github.com/leafqycc/rknn-multi-threaded)** - Multi-threaded NPU (+40% perf) 52 | 3. **[YOLOv5+DeepSORT ↗](https://github.com/Zhou-sx/yolov5_Deepsort_rknn)** - Real-time tracking 53 | 4. **[GStreamer MPP ↗](https://github.com/rockchip-linux/gstreamer-rockchip)** - Hardware-accelerated video 54 | 5. **[FFmpeg RKMPP ↗](https://github.com/rockchip-linux/ffmpeg-rockchip)** - 8K video codec 55 | 56 | ## Development Boards 57 | ### Consumer/Maker 58 | 1. **[Orange Pi 5 Series ↗](http://www.orangepi.org/)** - Best value (4-16GB, PCIe 3.0) 59 | 2. **[Radxa ROCK 5 ↗](https://radxa.com/products/rock5)** - Industrial grade, dual Ethernet 60 | 3. **[LubanCat RK3588 ↗](https://doc.embedfire.com/products/link/zh/latest/linux/ebf_lubancat.html)** - Rich IO, Chinese docs 61 | 62 | ### Industrial 63 | 1. **ITOP-3588 ↗** - Beijing Xunwei, full support 64 | 2. **FireFly ITX-3588J ↗** - Mini-ITX embedded form factor 65 | 66 | ## Documentation 67 | ### Technical 68 | 1. **[RK3588 Datasheet ↗](https://www.rock-chips.com/uploads/pdf/2022.8.26/191/RK3588%20Brief%20Datasheet.pdf)** - Official specs (6 TOPS, 8K@60fps) 69 | 2. **[RKNN User Guide ↗](https://github.com/airockchip/rknn-toolkit2/tree/master/doc)** - Conversion & deployment 70 | 3. **[RKNPU2 API Reference ↗](https://github.com/rockchip-linux/rknpu2/blob/master/doc/Rockchip_RKNPU_User_Guide_RKNN_API_V2.0.0.pdf)** - C/C++ API 71 | 72 | ### Board-Specific 73 | 1. **[Radxa ROCK 5 Docs ↗](https://docs.radxa.com/rock5)** - Excellent English docs 74 | 2. **[LubanCat Manual ↗](https://doc.embedfire.com/linux/rk3588/quick_start/zh/latest/)** - Best Chinese docs 75 | 76 | ## Development Tools 77 | 1. **[RKDevTool ↗](https://github.com/rockchip-linux/rkdeveloptool)** - Firmware flashing 78 | 2. **[RKNN-Toolkit2 Docker ↗](https://github.com/airockchip/rknn-toolkit2/tree/master/docker)** - Pre-configured environment 79 | 3. **NPU Monitor**: `cat /sys/kernel/debug/rknpu/load` 80 | 81 | ## Sample Code 82 | 1. **[RKNN Model Zoo ↗](https://github.com/airockchip/rknn_model_zoo)** - 30+ official model demos 83 | 2. **[rknn_api_demo ↗](https://github.com/rockchip-linux/rknpu2/tree/master/rknn_api_demo)** - Minimal C API examples 84 | 3. **[RKLLM Examples ↗](https://github.com/airockchip/rknn-llm/tree/main/examples)** - LLM chatbot demos 85 | 86 | ## Community 87 | ### International 88 | 1. **[Radxa Forum ↗](https://forum.radxa.com/)** - ROCK series community 89 | 2. **[Armbian Forum ↗](https://forum.armbian.com/forum/29-rockchip-3588-3566-3568-3399/)** - OS-level support 90 | 3. **[Orange Pi Forum ↗](http://www.orangepi.org/orangepibbsen/)** - Official Orange Pi forum 91 | 92 | ### Chinese 93 | 1. **[iTOP-RK3588 Forum ↗](http://bbs.topeetboard.com/forum.php?mod=forumdisplay&fid=55)** - Beijing Xunwei support 94 | 2. **[LubanCat Community ↗](https://forums.embedfire.com/c/lubancat/21)** - Wildfire Electronics 95 | 96 | --- 97 | 98 | ## Contribute 🤝 99 | 100 | Got a pull request? Open it, and we'll review it as soon as possible. If you have any suggestions or find any bugs and feel free to bring your fresh ideas to the table! [Contribution Guidelines](contributing.md) 101 | 102 | - [Open Issues](https://github.com/choushunn/awesome-RK3588/issues) 103 | - [Open Pull Requests](https://github.com/choushunn/awesome-RK3588/pulls) 104 | - [Open Discussions](https://github.com/choushunn/awesome-RK3588/discussions) 105 | 106 | This project exists thanks to all the people who contribute. [[Contribute](contributing.md)]. 107 | 108 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### JetBrains+all template 2 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 3 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 4 | 5 | # User-specific stuff 6 | .idea/**/workspace.xml 7 | .idea/**/tasks.xml 8 | .idea/**/usage.statistics.xml 9 | .idea/**/dictionaries 10 | .idea/**/shelf 11 | .idea/ 12 | # AWS User-specific 13 | .idea/**/aws.xml 14 | 15 | # Generated files 16 | .idea/**/contentModel.xml 17 | 18 | # Sensitive or high-churn files 19 | .idea/**/dataSources/ 20 | .idea/**/dataSources.ids 21 | .idea/**/dataSources.local.xml 22 | .idea/**/sqlDataSources.xml 23 | .idea/**/dynamic.xml 24 | .idea/**/uiDesigner.xml 25 | .idea/**/dbnavigator.xml 26 | 27 | # Gradle 28 | .idea/**/gradle.xml 29 | .idea/**/libraries 30 | 31 | # Gradle and Maven with auto-import 32 | # When using Gradle or Maven with auto-import, you should exclude module files, 33 | # since they will be recreated, and may cause churn. Uncomment if using 34 | # auto-import. 35 | # .idea/artifacts 36 | # .idea/compiler.xml 37 | # .idea/jarRepositories.xml 38 | # .idea/modules.xml 39 | # .idea/*.iml 40 | # .idea/modules 41 | # *.iml 42 | # *.ipr 43 | 44 | # CMake 45 | cmake-build-*/ 46 | 47 | # Mongo Explorer plugin 48 | .idea/**/mongoSettings.xml 49 | 50 | # File-based project format 51 | *.iws 52 | 53 | # IntelliJ 54 | out/ 55 | 56 | # mpeltonen/sbt-idea plugin 57 | .idea_modules/ 58 | 59 | # JIRA plugin 60 | atlassian-ide-plugin.xml 61 | 62 | # Cursive Clojure plugin 63 | .idea/replstate.xml 64 | 65 | # SonarLint plugin 66 | .idea/sonarlint/ 67 | 68 | # Crashlytics plugin (for Android Studio and IntelliJ) 69 | com_crashlytics_export_strings.xml 70 | crashlytics.properties 71 | crashlytics-build.properties 72 | fabric.properties 73 | 74 | # Editor-based Rest Client 75 | .idea/httpRequests 76 | 77 | # Android studio 3.1+ serialized cache file 78 | .idea/caches/build_file_checksums.ser 79 | 80 | ### C++ template 81 | # Prerequisites 82 | *.d 83 | 84 | # Compiled Object files 85 | *.slo 86 | *.lo 87 | *.o 88 | *.obj 89 | 90 | # Precompiled Headers 91 | *.gch 92 | *.pch 93 | 94 | # Compiled Dynamic libraries 95 | *.so 96 | *.dylib 97 | *.dll 98 | 99 | # Fortran module files 100 | *.mod 101 | *.smod 102 | 103 | # Compiled Static libraries 104 | *.lai 105 | *.la 106 | *.a 107 | *.lib 108 | 109 | # Executables 110 | *.exe 111 | *.out 112 | *.app 113 | 114 | ### JetBrains template 115 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 116 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 117 | 118 | # User-specific stuff 119 | 120 | # AWS User-specific 121 | 122 | # Generated files 123 | 124 | # Sensitive or high-churn files 125 | 126 | # Gradle 127 | 128 | # Gradle and Maven with auto-import 129 | # When using Gradle or Maven with auto-import, you should exclude module files, 130 | # since they will be recreated, and may cause churn. Uncomment if using 131 | # auto-import. 132 | # .idea/artifacts 133 | # .idea/compiler.xml 134 | # .idea/jarRepositories.xml 135 | # .idea/modules.xml 136 | # .idea/*.iml 137 | # .idea/modules 138 | # *.iml 139 | # *.ipr 140 | 141 | # CMake 142 | 143 | # Mongo Explorer plugin 144 | 145 | # File-based project format 146 | 147 | # IntelliJ 148 | 149 | # mpeltonen/sbt-idea plugin 150 | 151 | # JIRA plugin 152 | 153 | # Cursive Clojure plugin 154 | 155 | # SonarLint plugin 156 | 157 | # Crashlytics plugin (for Android Studio and IntelliJ) 158 | 159 | # Editor-based Rest Client 160 | 161 | # Android studio 3.1+ serialized cache file 162 | 163 | ### PythonVanilla template 164 | # Byte-compiled / optimized / DLL files 165 | __pycache__/ 166 | *.py[cod] 167 | *$py.class 168 | 169 | # C extensions 170 | 171 | # Distribution / packaging 172 | .Python 173 | build/ 174 | develop-eggs/ 175 | dist/ 176 | downloads/ 177 | eggs/ 178 | .eggs/ 179 | lib/ 180 | lib64/ 181 | parts/ 182 | sdist/ 183 | var/ 184 | wheels/ 185 | share/python-wheels/ 186 | *.egg-info/ 187 | .installed.cfg 188 | *.egg 189 | MANIFEST 190 | 191 | # Installer logs 192 | pip-log.txt 193 | pip-delete-this-directory.txt 194 | 195 | # Unit test / coverage reports 196 | htmlcov/ 197 | .tox/ 198 | .nox/ 199 | .coverage 200 | .coverage.* 201 | .cache 202 | nosetests.xml 203 | coverage.xml 204 | *.cover 205 | *.py,cover 206 | .hypothesis/ 207 | .pytest_cache/ 208 | cover/ 209 | 210 | # Translations 211 | *.mo 212 | *.pot 213 | 214 | # pyenv 215 | # For a library or package, you might want to ignore these files since the code is 216 | # intended to run in multiple environments; otherwise, check them in: 217 | # .python-version 218 | 219 | # pipenv 220 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 221 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 222 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 223 | # install all needed dependencies. 224 | #Pipfile.lock 225 | 226 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 227 | __pypackages__/ 228 | 229 | 230 | ### Linux template 231 | *~ 232 | 233 | # temporary files which can be created if a process still has a handle open of a deleted file 234 | .fuse_hidden* 235 | 236 | # KDE directory preferences 237 | .directory 238 | 239 | # Linux trash folder which might appear on any partition or disk 240 | .Trash-* 241 | 242 | # .nfs files are created when an open file is removed but is still being accessed 243 | .nfs* 244 | 245 | ### CMake template 246 | CMakeLists.txt.user 247 | CMakeCache.txt 248 | CMakeFiles 249 | CMakeScripts 250 | Testing 251 | Makefile 252 | cmake_install.cmake 253 | install_manifest.txt 254 | compile_commands.json 255 | CTestTestfile.cmake 256 | _deps 257 | 258 | ### JetBrains+iml template 259 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 260 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 261 | 262 | # User-specific stuff 263 | 264 | # AWS User-specific 265 | 266 | # Generated files 267 | 268 | # Sensitive or high-churn files 269 | 270 | # Gradle 271 | 272 | # Gradle and Maven with auto-import 273 | # When using Gradle or Maven with auto-import, you should exclude module files, 274 | # since they will be recreated, and may cause churn. Uncomment if using 275 | # auto-import. 276 | # .idea/artifacts 277 | # .idea/compiler.xml 278 | # .idea/jarRepositories.xml 279 | # .idea/modules.xml 280 | # .idea/*.iml 281 | # .idea/modules 282 | # *.iml 283 | # *.ipr 284 | 285 | # CMake 286 | 287 | # Mongo Explorer plugin 288 | 289 | # File-based project format 290 | 291 | # IntelliJ 292 | 293 | # mpeltonen/sbt-idea plugin 294 | 295 | # JIRA plugin 296 | 297 | # Cursive Clojure plugin 298 | 299 | # SonarLint plugin 300 | 301 | # Crashlytics plugin (for Android Studio and IntelliJ) 302 | 303 | # Editor-based Rest Client 304 | 305 | # Android studio 3.1+ serialized cache file 306 | 307 | ### Python template 308 | # Byte-compiled / optimized / DLL files 309 | 310 | # C extensions 311 | 312 | # Distribution / packaging 313 | 314 | # PyInstaller 315 | # Usually these files are written by a python script from a template 316 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 317 | *.manifest 318 | *.spec 319 | 320 | # Installer logs 321 | 322 | # Unit test / coverage reports 323 | 324 | # Translations 325 | 326 | # Django stuff: 327 | *.log 328 | local_settings.py 329 | db.sqlite3 330 | db.sqlite3-journal 331 | 332 | # Flask stuff: 333 | instance/ 334 | .webassets-cache 335 | 336 | # Scrapy stuff: 337 | .scrapy 338 | 339 | # Sphinx documentation 340 | docs/_build/ 341 | 342 | # PyBuilder 343 | .pybuilder/ 344 | target/ 345 | 346 | # Jupyter Notebook 347 | .ipynb_checkpoints 348 | 349 | # IPython 350 | profile_default/ 351 | ipython_config.py 352 | 353 | # pyenv 354 | # For a library or package, you might want to ignore these files since the code is 355 | # intended to run in multiple environments; otherwise, check them in: 356 | # .python-version 357 | 358 | # pipenv 359 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 360 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 361 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 362 | # install all needed dependencies. 363 | #Pipfile.lock 364 | 365 | # poetry 366 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 367 | # This is especially recommended for binary packages to ensure reproducibility, and is more 368 | # commonly ignored for libraries. 369 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 370 | #poetry.lock 371 | 372 | # pdm 373 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 374 | #pdm.lock 375 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 376 | # in version control. 377 | # https://pdm.fming.dev/#use-with-ide 378 | .pdm.toml 379 | 380 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 381 | 382 | # Celery stuff 383 | celerybeat-schedule 384 | celerybeat.pid 385 | 386 | # SageMath parsed files 387 | *.sage.py 388 | 389 | # Environments 390 | .env 391 | .venv 392 | env/ 393 | venv/ 394 | ENV/ 395 | env.bak/ 396 | venv.bak/ 397 | 398 | # Spyder project settings 399 | .spyderproject 400 | .spyproject 401 | 402 | # Rope project settings 403 | .ropeproject 404 | 405 | # mkdocs documentation 406 | /site 407 | 408 | # mypy 409 | .mypy_cache/ 410 | .dmypy.json 411 | dmypy.json 412 | 413 | # Pyre type checker 414 | .pyre/ 415 | 416 | # pytype static type analyzer 417 | .pytype/ 418 | 419 | # Cython debug symbols 420 | cython_debug/ 421 | 422 | # PyCharm 423 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 424 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 425 | # and can be added to the global gitignore or merged into this file. For a more nuclear 426 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 427 | #.idea/ 428 | 429 | --------------------------------------------------------------------------------