From 2623892173626606573efa3f198f080a299b2a0d Mon Sep 17 00:00:00 2001 From: ruki Date: Fri, 16 Nov 2018 23:16:32 +0800 Subject: [PATCH] init project --- .gitignore | 35 ++++++++ CHANGELOG.md | 24 ++++++ CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++ CONTRIBUTING.md | 51 +++++++++++ LICENSE.md | 211 +++++++++++++++++++++++++++++++++++++++++++++ NOTICE.md | 24 ++++++ README.md | 48 +++++++++++ README_zh.md | 51 +++++++++++ 8 files changed, 572 insertions(+) create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 NOTICE.md create mode 100644 README.md create mode 100644 README_zh.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ef0ff62 --- /dev/null +++ b/.gitignore @@ -0,0 +1,35 @@ +*.a +*.b +*.o +*.exe +*.obj +*.dll +*.lib +*.out +*.suo +*~ +*.swp +*.swo +*.bak +*.orig +*.pdb +*.idb +*.ilk +*.stackdump +*.manifest +.ccache +.demo +.svn +.DS_Store +.xmake +*.deb +*.zip +*.gch +*.gch.d +*.sys +cscope.* +gmon.out +tags +doc +install.log +build diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c06bc4d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,24 @@ +# Changelog ([中文](#中文)) + +## master (unreleased) + +### New features + +### Changes + +### Bug fixed + + +

+ +# 更新日志 + +## master (开发中) + +### 新特性 + +### 改进 + +### Bugs修复 + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c0d9359 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [waruqi@gmail.com]. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +# Contributor Covenant行为准则 + +# 参与者公约 + +## 我们的保证 + +为了促进一个开放透明且友好的环境，我们作为贡献者和维护者保证：无论年龄、种族、民族、性别认同和表达（方式）、体型、身体健全与否、经验水平、国籍、个人表现、宗教或性别取向，参与者在我们项目和社区中都免于骚扰。 + +## 我们的标准 + +有助于创造正面环境的行为包括但不限于： + +* 使用友好和包容性语言 +* 尊重不同的观点和经历 +* 耐心地接受建设性批评 +* 关注对社区最有利的事情 +* 友善对待其他社区成员 + +身为参与者不能接受的行为包括但不限于： + +* 使用与性有关的言语或是图像，以及不受欢迎的性骚扰 +* 捣乱/煽动/造谣的行为或进行侮辱/贬损的评论，人身攻击及政治攻击 +* 公开或私下的骚扰 +* 未经许可地发布他人的个人资料，例如住址或是电子地址 +* 其他可以被合理地认定为不恰当或者违反职业操守的行为 + +## 我们的责任 + +项目维护者有责任为「可接受的行为」标准做出诠释，以及对已发生的不被接受的行为采取恰当且公平的纠正措施。 + +项目维护者有权利及责任去删除、编辑、拒绝与本行为标准有所违背的评论 (comments)、提交 (commits)、代码、wiki 编辑、问题 (issues) 和其他贡献，以及项目维护者可暂时或永久性的禁止任何他们认为有不适当、威胁、冒犯、有害行为的贡献者。 + +## 使用范围 + +当一个人代表该项目或是其社区时，本行为标准适用于其项目平台和公共平台。 + +代表项目或是社区的情况，举例来说包括使用官方项目的电子邮件地址、通过官方的社区媒体账号发布或线上或线下事件中担任指定代表。 + +该项目的呈现方式可由其项目维护者进行进一步的定义及解释。 + +## 强制执行 + +可以通过[waruqi@gmail.com]，来联系项目团队来举报滥用、骚扰或其他不被接受的行为。 + +任何维护团队认为有必要且适合的所有投诉都将进行审查及调查，并做出相对应的回应。项目小组有对事件回报者有保密的义务。具体执行的方针近一步细节可能会单独公布。 + +没有切实地遵守或是执行本行为标准的项目维护人员，可能会因项目领导人或是其他成员的决定，暂时或是永久地取消其参与资格。 + +## 来源 + +本行为标准改编自[贡献者公约][主页]，版本 1.4 +可在此观看https://www.contributor-covenant.org/zh-cn/version/1/4/code-of-conduct.html + +[主页]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3a690e7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# Contributing + +If you discover issues, have ideas for improvements or new features, or +want to contribute a new module, please report them to the +[issue tracker][1] of the repository or submit a pull request. Please, +try to follow these guidelines when you do so. + +## Issue reporting + +* Check that the issue has not already been reported. +* Check that the issue has not already been fixed in the latest code + (a.k.a. `master`). +* Be clear, concise and precise in your description of the problem. +* Open an issue with a descriptive title and a summary in grammatically correct, + complete sentences. +* Include any relevant code to the issue summary. + +## Pull requests + +* Use a topic branch to easily amend a pull request later, if necessary. +* Write good commit messages. +* Use the same coding conventions as the rest of the project. +* Ensure your edited codes with four spaces instead of TAB. +* Please commit code to `dev` branch and we will merge into `master` branch in future. + +# 贡献代码 + +如果你发现一些问题，或者想新增或者改进某些新特性，或者想贡献一个新的模块 +那么你可以在[issues][1]上提交反馈，或者发起一个提交代码的请求(pull request). + +## 问题反馈 + +* 确认这个问题没有被反馈过 +* 确认这个问题最近还没有被修复，请先检查下 `master` 的最新提交 +* 请清晰详细地描述你的问题 +* 如果发现某些代码存在问题，请在issue上引用相关代码 + +## 提交代码 + +* 请先更新你的本地分支到最新，再进行提交代码请求，确保没有合并冲突 +* 编写友好可读的提交信息 +* 请使用与工程代码相同的代码规范 +* 确保提交的代码缩进是四个空格，而不是tab +* 请提交代码到`dev`分支，如果通过，我们会在特定时间合并到`master`分支上 +* 为了规范化提交日志的格式，commit消息，不要用中文，请用英文描述 + +[1]: https://github.com/tboox/ltui/issues + + + + diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..361f692 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,211 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2016-2018 TBOOX Open Source Group + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +------------------------------------------------------------------------------- +## SUBCOMPONENTS + +The LTUI project contains subcomponents with separate copyright +notices and license terms. Your use of the source code for the these +subcomponents is subject to the terms and conditions of the following +licenses. + diff --git a/NOTICE.md b/NOTICE.md new file mode 100644 index 0000000..6aa8ca2 --- /dev/null +++ b/NOTICE.md @@ -0,0 +1,24 @@ +A cross-platform build utility based on Lua +Copyright 2015-2018 The TBOOX Open Source Group + +This product includes software developed by The TBOOX Open Source Group (http://www.tboox.org/). + +------------------------------------------------------------------------------- + +This product depends on 'pdcurses', an implementation of X/Open curses for multiple platforms, +which can be obtained at: + + * LICENSE: + * Public Domain License + * HOMEPAGE: + * http://pdcurses.org/ + +This product depends on 'lcurses/cui', Lua Console User Interface, +which can be obtained at: + + * LICENSE: + * core/src/lcurses/LICENSE (MIT License) + * HOMEPAGE: + * http://lua-cui.sourceforge.net/ + + diff --git a/README.md b/README.md new file mode 100644 index 0000000..e963c98 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +
+

LTUI

+ +
+ + Github All Releases + + + license + + + Reddit + + + Gitter + + + Telegram + + + QQ + + + Donate + +
+

A cross-platform terminal ui library based on Lua

+
+ +## Introduction ([中文](/README_zh.md)) + +LTUI is a cross-platform terminal ui library based on Lua. + + +If you want to known more, please refer to: + +* [HomePage](http://www.tboox.org) +* [Github](https://github.com/tboox/ltui) +* [Gitee](https://gitee.com/tboox/ltui) + +## Contacts + +* Email：[waruqi@gmail.com](mailto:waruqi@gmail.com) +* Homepage：[tboox.org](http://www.tboox.org) +* Community：[/r/tboox on reddit](https://www.reddit.com/r/tboox/) +* ChatRoom：[Char on telegram](https://t.me/tbooxorg), [Chat on gitter](https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +* Source Code：[Github](https://github.com/tboox/ltui), [Gitee](https://gitee.com/tboox/ltui) + diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 0000000..db17f0f --- /dev/null +++ b/README_zh.md @@ -0,0 +1,51 @@ + +
+

LTUI

+ +
+ + Github All Releases + + + license + + + Reddit + + + Gitter + + + Telegram + + + QQ + + + Donate + +
+

A cross-platform terminal ui library based on Lua

+
+ +## 简介 + +LTUI是一个基于lua的跨平台字符终端UI界面库。 + + +如果你想了解更多，请参考： + +* [主页](http://www.tboox.org) +* [Github](https://github.com/tboox/ltui) +* [Gitee](https://gitee.com/tboox/ltui) + +## 联系方式 + +* 邮箱：[waruqi@gmail.com](mailto:waruqi@gmail.com) +* 主页：[tboox.org](http://www.tboox.org) +* 社区：[Reddit论坛](https://www.reddit.com/r/tboox/) +* 聊天：[Telegram群组](https://t.me/tbooxorg), [Gitter聊天室](https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +* 源码：[Github](https://github.com/tboox/ltui), [Gitee](https://gitee.com/tboox/ltui) +* QQ群：343118190 +* 微信公众号：tboox-os +