init: Basic description about LibcarePlus
This commit add basic description about LibcarePlus in README.md Signed-off-by: Ying Fang <fangying1@huawei.com>
This commit is contained in:
Ying Fang
Ying Fang
parent
5ef17d5b16
commit
741587777f
48
README.en.md
48
README.en.md
@ -3,34 +3,38 @@
|
|||||||
#### Description
|
#### Description
|
||||||
LibcarePlus delivers live patches to any of your Linux executables or libraries at the runtime, without the need for restart of your applications.
|
LibcarePlus delivers live patches to any of your Linux executables or libraries at the runtime, without the need for restart of your applications.
|
||||||
|
|
||||||
|
LibcarePlus is a self maintained branch derived from the LibCare project. It is released with the same LICENSE with LibCare and the original Copyright is kept.
|
||||||
|
|
||||||
|
More information about LibCare can be reached at:
|
||||||
|
|
||||||
|
[https://github.com/cloudlinux/libcare](https://github.com/cloudlinux/libcare)
|
||||||
|
|
||||||
|
LibcarePlus aims at providing userspac livepatch ability
|
||||||
|
for popular architecture like x86_64 and aarch64.
|
||||||
|
|
||||||
#### Software Architecture
|
#### Software Architecture
|
||||||
Software architecture description
|
|
||||||
|
For more information about the design of LibcarePlus,
|
||||||
|
please refer to the `LibcarePlus Design`.
|
||||||
|
|
||||||
#### Installation
|
#### Installation
|
||||||
|
|
||||||
1. xxxx
|
Please refer to the `LibcarePlus Intallation Guide` to
|
||||||
2. xxxx
|
complete the installation of LibcarePlus.
|
||||||
3. xxxx
|
|
||||||
|
|
||||||
#### Instructions
|
|
||||||
|
|
||||||
1. xxxx
|
### User Guide
|
||||||
2. xxxx
|
|
||||||
3. xxxx
|
Please refer to:
|
||||||
|
|
||||||
|
* LibcarePlus Patch Make Tutorial
|
||||||
|
* LibcarePlus Patch Apply Tutorial
|
||||||
|
|
||||||
|
to help you to make the patch and apply it to the target process.
|
||||||
|
|
||||||
#### Contribution
|
#### Contribution
|
||||||
|
|
||||||
1. Fork the repository
|
Any contributors are wellcome to join this project,
|
||||||
2. Create Feat_xxx branch
|
we are glad to provide help and guide needed.
|
||||||
3. Commit your code
|
Developers can post an issue on this project and
|
||||||
4. Create Pull Request
|
make a pull request to join the development process.
|
||||||
|
|
||||||
|
|
||||||
#### Gitee Feature
|
|
||||||
|
|
||||||
1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
|
|
||||||
2. Gitee blog [blog.gitee.com](https://blog.gitee.com)
|
|
||||||
3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
|
|
||||||
4. The most valuable open source project [GVP](https://gitee.com/gvp)
|
|
||||||
5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
|
|
||||||
6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
|
||||||
40
README.md
40
README.md
@ -1,37 +1,33 @@
|
|||||||
# libcareplus
|
# libcareplus
|
||||||
|
|
||||||
#### 介绍
|
#### 介绍
|
||||||
LibcarePlus delivers live patches to any of your Linux executables or libraries at the runtime, without the need for restart of your applications.
|
|
||||||
|
LibcarePlus是一个通用的用户态热补丁框架，它可以被用来对Linux可执行程序或者动态链接库打补丁，而不需要重启应用程序。
|
||||||
|
|
||||||
|
LibcarePlus是一个基于LibCare的独立发展分支， 采用和LibCare相同License发布并保留原作者的Copyright，
|
||||||
|
更多关于LibCare的信息可以从以下链接获取：
|
||||||
|
|
||||||
|
[https://github.com/cloudlinux/libcare](https://github.com/cloudlinux/libcare)
|
||||||
|
|
||||||
|
LibcarePlus的发展目标是对x86_64和aarch64等常见体系结构提供用户态热补丁能力支持。
|
||||||
|
|
||||||
#### 软件架构
|
#### 软件架构
|
||||||
软件架构说明
|
|
||||||
|
|
||||||
|
想获取更多的LibcarePlus核心架构设计信息，请参考`LibcarePlus Design`。
|
||||||
|
|
||||||
#### 安装教程
|
#### 安装教程
|
||||||
|
|
||||||
1. xxxx
|
请参考`LibcarePlus安装指南`来完成LibcarePlus的安装。
|
||||||
2. xxxx
|
|
||||||
3. xxxx
|
|
||||||
|
|
||||||
#### 使用说明
|
#### 使用说明
|
||||||
|
|
||||||
1. xxxx
|
请参考：
|
||||||
2. xxxx
|
|
||||||
3. xxxx
|
* LibcarePlus热补丁制作指导
|
||||||
|
* LibcarePlus热补丁应用指导
|
||||||
|
|
||||||
|
来完成补丁的制作和打补丁的操作流程。
|
||||||
|
|
||||||
#### 参与贡献
|
#### 参与贡献
|
||||||
|
|
||||||
1. Fork 本仓库
|
我们非常欢迎新贡献者的加入，并且非常乐意为新的贡献者提供指导和帮助。 开发者可以通过在本仓库提Issue来描述需求，并通过PR体检提交代码的方式参与开发。
|
||||||
2. 新建 Feat_xxx 分支
|
|
||||||
3. 提交代码
|
|
||||||
4. 新建 Pull Request
|
|
||||||
|
|
||||||
|
|
||||||
#### 特技
|
|
||||||
|
|
||||||
1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
|
|
||||||
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
|
|
||||||
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
|
|
||||||
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
|
|
||||||
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
|
|
||||||
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
|
||||||
Loading…
x
Reference in New Issue
Block a user