Merge pull request #31 from DrugsZ/doc-readme

docs: add README and CONTRIBUTIONG

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing to Latte
+
+First off, thank you for considering contributing to Latte.
+
+## Where to Start
+
+1. **Issues**: The [issue list](https://github.com/DrugsZ/Latte/issues) is the best place to start. Issues tagged with `good first issue` are a good starting point.
+2. **Discussions**: Join the discussions on the project's [Discussions](https://github.com/DrugsZ/Latte/discussions) page to connect with other community members.
+
+## How to Contribute
+
+### Reporting Bugs
+
+1. **Search**: Check if the issue has already been reported.
+2. **Be clear**: Provide a clear and descriptive title for the issue.
+3. **Include details**: Include as much information as possible, such as the version of Latte, your operating system, and steps to reproduce the issue.
+
+### Suggesting Enhancements
+
+1. **Search**: Check if the enhancement has already been suggested.
+2. **Be clear**: Provide a clear and descriptive title for the enhancement.
+3. **Explain**: Explain why this enhancement would be useful and how it would work.
+
+### Your First Code Contribution
+
+1. **Fork** the repository to your own GitHub account.
+2. **Make your changes** and **add tests** if necessary.
+3. **Commit** your changes
+4. **Push** your branch to GitHub
+5. **Open a pull request** against the `main` branch.
+
+### Pull Request Guidelines
+
+1. **Update** the documentation if necessary.
+2. **Follow** the coding style of the project.
+3. **Write tests** for your changes.
+4. **Keep your changes** focused on a single feature or fix.
+5. **Rebase** your branch on the latest `main` before submitting a pull request.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the [Apache-2.0 license](https://github.com/DrugsZ/Latte?tab=Apache-2.0-1-ov-file) used within this project.
+
+## Additional Notes
+
+- **Sign your work**: The sign-off is required for all contributions. It certifies that you wrote the patch or have the right to contribute it to the project.
+- **Ask for help**: If you’re stuck, create a draft pull request or ask for help on the [Discussions](https://github.com/DrugsZ/Latte/discussions) page.
+
+Thank you for your interest in contributing to Latte!

README-zh_CN.md

@@ -0,0 +1,66 @@
+当然可以，以下是将你提供的项目描述翻译成中文的版本：
+
+# Latte
+
+<!-- PROJECT SHIELDS -->
+
+[贡献者][contributors-url]
+[分支][forks-url]
+[星标][stars-url]
+[问题][issues-url]
+[MIT 许可证][license-url]
+
+<!-- PROJECT LOGO -->
+
+Canvas 驱动的设计工具
+
+Latte 旨在为任何网页端提供底层 2D 渲染能力，使任何开发者可以方便快捷地开发属于自己的图形编辑工具。
+`<br />`
+
+## 🛠️ 开发
+
+开始预览演示：
+
+```bash
+  git clone git@github.com:DrugsZ/Latte.git
+  cd Latte
+  pnpm install
+  pnpm build
+  pnpm start
+```
+
+### 运行测试用例
+
+```bash
+pnpm test
+```
+
+## 如何贡献
+
+```markdown
+如果您对修复问题并直接向代码库贡献感兴趣，请参见[如何贡献](https://github.com/DrugsZ/Latte/blob/master/
+.md)。
+
+感谢您的贡献！
+```
+
+## 灵感来源
+
+- [AntV G](https://github.com/antvis/G)
+- [Pixi.js](https://pixijs.com/)
+- [Figma](https://www.figma.com/)
+- [VSCode](https://github.com/microsoft/vscode)
+- [Fabric](http://fabricjs.com/)
+
+<!-- links -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/DrugsZ/Latte.svg?style=flat-square
+[contributors-url]: https://github.com/DrugsZ/Latte/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/DrugsZ/Latte.svg?style=flat-square
+[forks-url]: https://github.com/DrugsZ/Latte/network/members
+[stars-shield]: https://img.shields.io/github/stars/DrugsZ/Latte.svg?style=flat-square
+[stars-url]: https://github.com/DrugsZ/Latte/stargazers
+[issues-shield]: https://img.shields.io/github/issues/DrugsZ/Latte.svg?style=flat-square
+[issues-url]: https://github.com/DrugsZ/Latte/issues
+[license-shield]: https://img.shields.io/github/license/DrugsZ/Latte.svg?style=flat-square
+[license-url]: https://github.com/DrugsZ/Latte/blob/master/LICENSE.txt

README.md

@@ -1 +1,61 @@
 # Latte
+
+<!-- PROJECT SHIELDS -->
+
+[Contributors][contributors-url]
+[Forks][forks-url]
+[Stars][stars-url]
+[Issues][issues-url]
+[MIT License][license-url]
+
+<!-- PROJECT LOGO -->
+
+A Canvas-Powered Design Tool
+
+Latte aims to provide underlying 2D rendering capabilities to any web page, enabling any developer to quickly and conveniently develop their own graphic editing tools.
+`<br />`
+
+## 🛠️ Development
+
+Start previewing demos:
+
+```bash
+  git clone git@github.com:DrugsZ/Latte.git
+  cd Latte
+  pnpm install
+  pnpm build
+  pnpm start
+```
+
+### Run test cases
+
+```bash
+pnpm test
+```
+
+### Contributing
+
+If you are interested in fixing issues and contributing directly to the code base, please see the document [How to Contribute](https://github.com/DrugsZ/Latte/blob/master/CONTRIBUTING.md).
+
+Thank you for your contributions!
+
+## Inspired by
+
+- [AntV G](https://github.com/antvis/G)
+- [Pixi.js](https://pixijs.com/)
+- [Figma](https://www.figma.com/)
+- [VSCode](https://github.com/microsoft/vscode)
+- [Fabric](http://fabricjs.com/)
+
+<!-- links -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/DrugsZ/Latte.svg?style=flat-square
+[contributors-url]: https://github.com/DrugsZ/Latte/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/DrugsZ/Latte.svg?style=flat-square
+[forks-url]: https://github.com/DrugsZ/Latte/network/members
+[stars-shield]: https://img.shields.io/github/stars/DrugsZ/Latte.svg?style=flat-square
+[stars-url]: https://github.com/DrugsZ/Latte/stargazers
+[issues-shield]: https://img.shields.io/github/issues/DrugsZ/Latte.svg?style=flat-square
+[issues-url]: https://github.com/DrugsZ/Latte/issues
+[license-shield]: https://img.shields.io/github/license/DrugsZ/Latte.svg?style=flat-square
+[license-url]: https://github.com/DrugsZ/Latte/blob/master/LICENSE.txt