From 9bf2e339e76bcba59ab9f59bd9d0246a2b78c061 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Xuan=20Huang=20=28=E9=BB=84=E7=8E=84=29?= <5563315+Huxpro@users.noreply.github.com> Date: Mon, 3 Mar 2025 10:34:01 -0800 Subject: [PATCH 1/2] Polish README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Xuan Huang (้ป„็Ž„) <5563315+Huxpro@users.noreply.github.com> --- README.md | 64 +++++++++++++++++-------------------------------------- 1 file changed, 19 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 9b8fc13eb7..b0ae0d3d73 100644 --- a/README.md +++ b/README.md @@ -6,27 +6,10 @@

-### ๐ŸŽจ Multi-Platform Support - -**Write once, run anywhere!** - -Lynx offers robust native rendering for Android and iOS, while also supporting custom rendering across desktop platforms like Windows and macOS. With its versatile renderer, Lynx can even power web applications, making it a true cross-platform solution. - -### ๐ŸŒ Web-Inspired Development - -**Familiar tools, faster results!** - -Lynx brings the simplicity of web development to mobile and desktop platforms. By incorporating JavaScript and CSS concepts, it introduces a tailored CSS subset with Lynx-specific extensions, an optimized JavaScript runtime, and support for many W3C APIs. Developers can seamlessly apply their knowledge of React, CSS, and web development to create sophisticated apps with Lynx. - -### ๐Ÿš€ High Performance - -**Blazing fast, every time!** - -Lynx is engineered for speed, offering native UI responsiveness through a custom layout engine and a browser-inspired multithreading architecture. Whether used as a standalone framework or embedded within native views, Lynx ensures exceptional performance and a seamless user experience. +This repository contains the **core JavaScript stack** of Lynx, including [ReactLynx][1], [Rspeedy][2], [Lynx for Web][3], and more. For other repositories in the Lynx family, visit our [org homepage](https://github.com/lynx-family). ## Content -- [Showcases](#Showcases) - [Getting Started](#Getting-Started) - [Documentation](#Documentation) - [How to Contribute](#How-to-Contribute) @@ -35,43 +18,29 @@ Lynx is engineered for speed, offering native UI responsiveness through a custom ## Getting Started -### Requirements - -- **App Development**: - - - **Node.js 18** or later. Requires **Node.js 18.19** when using TypeScript as configuration. - -- **Client Development**: - - - Lynx apps should target **iOS 15.1** and **Android 7.0 (API 24)** or newer. - - - **Windows**, **macOS**, or **Linux**. Building and running iOS apps is only supported on **macOS**. - -### Explore Lynx with a โ€œHello Worldโ€ Example - -Experience Lynx in action with the Lynx Explorer App, a demo app that showcases Lynx's capabilities: -Get the app here (link coming soon) - -### Creating a New Lynx Application - -Learn how to create a new Lynx project from scratch: -[Quick Start](https://lynxjs.org/guide/start-with-react/quick-start) +- Trying out Lynx with [hello world](https://lynxjs.org/guide/start/quick-start.html) +- [Integrating Lynx with an Existing Application](https://lynxjs.org/guide/start/integrate-with-existing-apps.html) ## Documentation -Find the complete documentation for Lynx on [our official website](https://lynxjs.org). +Find the complete documentation for Lynx on [lynxjs.org](https://lynxjs.org). ## How to Contribute -[Code of Conduct](./CODE_OF_CONDUCT.md) +### [Code of Conduct][coc] +We are devoted to ensuring a positive, inclusive, and safe environment for all contributors. Please find our [Code of Conduct][coc] for detailed information. -[Contributing Guide](./CONTRIBUTING.md) +[coc]: CODE_OF_CONDUCT.md -## Discussions +### [Contributing Guide][contributing] +We welcome you to join and become a member of Lynx Authors. It's people like you that make this project great. + +Please refer to our [contributing guide][contributing] for details. -Join the conversation! +[contributing]: CONTRIBUTING.md -For in-depth discussions, proposals, and community feedback, visit our GitHub Discussions. +## Discussions +Large discussions and proposals are discussed in [Github Discussions](https://github.com/lynx-family/lynx-stack/discussions) ## License @@ -86,3 +55,8 @@ Thanks to: - [React Native](https://reactnative.dev/) for groundbreaking work in allowing developers to create truly native apps using JavaScript and React. - [Rspack](https://rspack.dev/) for providing a fast and flexible build tool that has significantly enhanced the build performance of Lynx projects. - [React Native for Web](https://necolas.github.io/react-native-web/) project for inspiring the Lynx for Web project, motivating our architectural design with its accessible implementation and interoperability with React DOM. + + +[1]: https://github.com/lynx-family/lynx-stack/tree/main/packages/react +[2]: https://github.com/lynx-family/lynx-stack/tree/main/packages/rspeedy +[3]: https://github.com/lynx-family/lynx-stack/tree/main/packages/web-platform From 23e0f50fb05517c396ad894c38feb8f5e8027e7d Mon Sep 17 00:00:00 2001 From: "zhanglei.z" Date: Tue, 4 Mar 2025 11:13:27 +0800 Subject: [PATCH 2/2] fix: README format --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b0ae0d3d73..15f2ab7bb2 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,13 @@ Find the complete documentation for Lynx on [lynxjs.org](https://lynxjs.org). ## How to Contribute ### [Code of Conduct][coc] + We are devoted to ensuring a positive, inclusive, and safe environment for all contributors. Please find our [Code of Conduct][coc] for detailed information. [coc]: CODE_OF_CONDUCT.md ### [Contributing Guide][contributing] + We welcome you to join and become a member of Lynx Authors. It's people like you that make this project great. Please refer to our [contributing guide][contributing] for details. @@ -40,6 +42,7 @@ Please refer to our [contributing guide][contributing] for details. [contributing]: CONTRIBUTING.md ## Discussions + Large discussions and proposals are discussed in [Github Discussions](https://github.com/lynx-family/lynx-stack/discussions) ## License @@ -56,7 +59,6 @@ Thanks to: - [Rspack](https://rspack.dev/) for providing a fast and flexible build tool that has significantly enhanced the build performance of Lynx projects. - [React Native for Web](https://necolas.github.io/react-native-web/) project for inspiring the Lynx for Web project, motivating our architectural design with its accessible implementation and interoperability with React DOM. - [1]: https://github.com/lynx-family/lynx-stack/tree/main/packages/react [2]: https://github.com/lynx-family/lynx-stack/tree/main/packages/rspeedy [3]: https://github.com/lynx-family/lynx-stack/tree/main/packages/web-platform