diff --git a/README.md b/README.md index 6d3019f139e3460ad93f8c60d4d1e928806d4b12..08dd7a29bfa56bfcc07012922472f73597eeab0d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ + + +# EcuBus-Pro +
@@ -32,7 +36,7 @@ EcuBus-Pro is an open-source alternative to commercial automotive diagnostic too - ๐Ÿ†“ Open-source and free to use - ๐Ÿš€ Modern, intuitive user interface -- ๐Ÿ’ป Cross-platform support (Windows, Linux, MacOS) - [Install](./docs/about/install.md) +- ๐Ÿ’ป Cross-platform support (Windows, Linux, MacOS) - [Install](./docs/en/about/install.md) - ๐Ÿ”Œ Multi-hardware support - **[EcuBus-LinCable](https://app.whyengineer.com/docs/um/hardware/lincable.html)**: LIN (Support Lin conformance test), [PWM](https://app.whyengineer.com/docs/um/pwm/pwm.html) - **PEAK**: CAN, CAN-FD, LIN @@ -44,16 +48,58 @@ EcuBus-Pro is an open-source alternative to commercial automotive diagnostic too - **GS_USB (CANDLE)**: CAN, CAN-FD [Detail](https://app.whyengineer.com/docs/um/can/can.html#gs-usb) - ๐Ÿ› ๏ธ Comprehensive diagnostic capabilities - **Diagnostic Protocols**: CAN/CAN-FD, DoIP, LIN -- ๐ŸŒ **SOME/IP**: SOME/IP protocol support - [Details](./docs/um/someip/index.md) -- ๐Ÿ“ **Scripting**: Advanced TypeScript-based automation - [Details](./docs/um/script.md) -- ๐Ÿงช **Test**: HIL Test Framework - [Details](./docs/um/test/test.md) -- ๐Ÿ“Š **Database Support**: LIN LDF (edit & export), CAN DBC (view) - [Details](./docs/um/database.md) -- ๐Ÿ“ˆ **Data Visualization**: Real-time signal graphing and analysis - [Details](./docs/um/graph/graph.md) -- โŒจ๏ธ **Command Line**: Full-featured CLI for automation and integration - [Details](./docs/um/cli.md) -- ๐ŸŽจ **Panel**: Drag-and-drop interface builder for custom UI - [Details](./docs/um/panel/index.md) +- ๐ŸŒ **SOME/IP**: SOME/IP protocol support - [Details](./docs/en/um/someip/index.md) +- ๐Ÿ“ **Scripting**: Advanced TypeScript-based automation - [Details](./docs/en/um/script.md) +- ๐Ÿงช **Test**: HIL Test Framework - [Details](./docs/en/um/test/test.md) +- ๐Ÿ“Š **Database Support**: LIN LDF (edit & export), CAN DBC (view) - [Details](./docs/en/um/database/database.md) +- ๐Ÿ“ˆ **Data Visualization**: Real-time signal graphing and analysis - [Details](./docs/en/um/graph/graph.md) +- โŒจ๏ธ **Command Line**: Full-featured CLI for automation and integration - [Details](./docs/en/um/cli/cli.md) +- ๐ŸŽจ **Panel**: Drag-and-drop interface builder for custom UI - [Details](./docs/en/um/panel/index.md) [Read the Docs to Learn More.](https://app.whyengineer.com) +## Installation + +### Windows + +Download the installer from [GitHub Releases](https://github.com/ecubus/EcuBus-Pro/releases) or use the portable version. + +### Linux + +For Arch Linux, install from AUR: +```bash +yay -S ecubus-pro +``` + +Or download the AppImage from [GitHub Releases](https://github.com/ecubus/EcuBus-Pro/releases). + +### macOS + +Download the `.dmg` installer from [GitHub Releases](https://github.com/ecubus/EcuBus-Pro/releases). + +For detailed installation instructions, see [Install Guide](./docs/en/about/install.md). + +## Quick Start + +1. Launch EcuBus-Pro +2. Connect your hardware device +3. Create or open a project +4. Start diagnostic operations + +## Documentation + +- **English Documentation**: [https://app.whyengineer.com](https://app.whyengineer.com) +- **Chinese Documentation**: [https://app.whyengineer.com/zh](https://app.whyengineer.com/zh) + +### Key Documentation Topics + +- [CAN Configuration](docs/en/um/can/can.md) +- [LIN Development](docs/en/um/lin/lin.md) +- [DoIP Diagnostics](docs/en/um/doip/doip.md) +- [Scripting Guide](docs/en/um/script/script.md) +- [UDS Services](docs/en/um/uds/example/example.md) +- [CLI Reference](docs/en/um/cli/cli.md) +- [Test Framework](docs/en/um/test/test.md) ## Support & Sponsorship @@ -63,13 +109,13 @@ EcuBus-Pro is an open-source alternative to commercial automotive diagnostic too - Become a Sponsor + Become a Sponsor - Become a Sponsor + Become a Sponsor - Become a Sponsor + Become a Sponsor @@ -85,23 +131,35 @@ EcuBus-Pro is an open-source alternative to commercial automotive diagnostic too - Become a Sponsor + Become a Sponsor - Become a Sponsor + Become a Sponsor - Become a Sponsor + Become a Sponsor
---- +Consider [becoming a sponsor](./docs/en/about/sponsor) to support ongoing development. Sponsors receive prominent logo placement with website links. ๐Ÿ™ -Consider [becoming a sponsor](./docs/about/sponsor) to support ongoing development. Sponsors receive prominent logo placement with website links. ๐Ÿ™ +## Contributing +Contributions are welcome! Please review our [contribution guidelines](./.github/contributing.md) before getting started. + +### Development Setup + +For developers who want to contribute: + +1. Install Node.js (recommended version in package.json) +2. Install dependencies: `npm install` or `pnpm install` +3. Build native modules +4. Run development server + +See [Developer Setup Guide](./docs/en/dev/setup.md) for detailed instructions. ## Contributors @@ -109,10 +167,10 @@ Thanks to all the contributors who have helped shape EcuBus-Pro: -We welcome contributions! Please review our [contribution guidelines](./.github/contributing.md) before getting started. - ## License [Apache License 2.0](./license.txt) +--- +Copyright ยฉ 2024 EcuBus-Pro Team. All rights reserved. \ No newline at end of file