diff --git a/README-en.md b/README-en.md new file mode 100644 index 0000000000000000000000000000000000000000..b6b41463cf356edb1c8c5d916cd14c308c334f5b --- /dev/null +++ b/README-en.md @@ -0,0 +1,72 @@ +# Introduction to UniProton + +UniProton is a real-time operating system with extreme low latency and flexible mixed-critical deployment features that can be applied to industrial control scenarios, supporting both microcontroller MCUs and powerful multi-core CPUs. + +一. Set up the UniProton development environment +---------- +### 1. Download the source code +```bash +git clone https://gitee.com/openeuler/UniProton.git +``` + +[Introduction to the source code directory](./doc/getting_started.md) + +### 2.Create a development project + +[Hello word example](./doc/getting_started.md) + +### 3.Compilation + +[Compilation steps](./doc/UniProton_build,md) + +### 4. Run + +[Example of a Raspberry Pi 4B hybrid deployment](./doc/demoUsageGuide/raspi4_demo_usage_guide.md) + +[Hi3093 hybrid deployment example](./doc/demoUsageGuide/hi3093_demo_usage_guide.md) + +[x86_64 an example of a hybrid deploymenti](./doc/demoUsageGuide/x86_64_demo_usage_guide.md) + +[UniProton gdb-stub User Guide](./doc/gdbstub.md) + +### 5. Relevant documents + +[UniProton User Guide](https://docs.openeuler.org/zh/docs/23.09/docs/Embedded/UniProton/UniProton%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97-%E6%A6%82%E8%BF%B0.html) + +[UniProton Interface Documentation](https://docs.openeuler.org/zh/docs/23.09/docs/Embedded/UniProton/UniProton%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E.html) + +[Introduction to the YOCTO build system](https://openeuler.gitee.io/yocto-meta-openeuler/master/yocto/index.html) + +[OEBUILD container guidance](https://openeuler.gitee.io/yocto-meta-openeuler/master/oebuild/intro.html) + +[Deploy MCS repositories in a hybrid manner](https://gitee.com/openeuler/mcs) + +[git commit specification](https://openeuler.gitee.io/yocto-meta-openeuler/master/develop_help/commit.html) + +二.Function introduction +---------- + +- [task](./doc/design/task.md) +- [interrupt](./doc/design/hwi.md) +- [event](./doc/design/event.md) +- [queue](./doc/design/queue.md) +- [Semaphore](./doc/design/sem.md) +- [Memory management](./doc/design/mem.md) +- [Software timer](./doc/design/timer.md) +- [abnormal](./doc/design/exc.md) +- [Error handling](./doc/design/err.md) +- [CPU usage](./doc/design/cpup.md) + +三. Disclaimer +---------- + +1. The current open-source version supports cortex_m4, armv8, and x86_64 chips, and the secure compilation option of the default compilation script only supports stack protection, and other options are added by users as needed. + +2. Licensed under the MulanPSL2 open source license + +四. Fourth, how to contribute +---------- + +We welcome new contributors to the project and are excited to provide guidance and assistance to new contributors. Before you can contribute code, you need to sign the [CLA](https://clasign.osinfra.cn/sign/Z2l0ZWUlMkZvcGVuZXVsZXI=). + +For details about how to join openEuler, see [https://www.openeuler.org/zh/community/contribution](https://www.openeuler.org/zh/community/contribution)