feat: 📝更新readme文档
This commit is contained in:
parent
1fa382683d
commit
ed878546b4
145
README.md
145
README.md
@ -1,92 +1,115 @@
|
|||||||
# UCP4008_PLATFORM_APP
|
# yb_arm
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Getting started
|
### 拉取与推送：
|
||||||
|
|
||||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
|
||||||
|
|
||||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
|
||||||
|
|
||||||
## Add your files
|
|
||||||
|
|
||||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
|
||||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
|
||||||
|
|
||||||
|
【需要验证的方式】使用HTTP拉取项目：
|
||||||
```
|
```
|
||||||
cd existing_repo
|
git clone http://47.100.68.68:3000/BUPT/yb_arm.git
|
||||||
git remote add origin http://gitlab.smartlogictech.com/ucp/driver/ucp4008_platform_app.git
|
|
||||||
git branch -M main
|
|
||||||
git push -uf origin main
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Integrate with your tools
|
命令行中会让你输入自己的账号和密码。
|
||||||
|
|
||||||
- [ ] [Set up project integrations](http://gitlab.smartlogictech.com/ucp/driver/ucp4008_platform_app/-/settings/integrations)
|
```
|
||||||
|
> git clone http://47.100.68.68:3000/BUPT/yb_arm.git
|
||||||
|
Username for 'http://47.100.68.68:3000': <输入你的gitea账户名>
|
||||||
|
Password for 'http://qieyuan@47.100.68.68:3000': <输入你的gitea密码>
|
||||||
|
```
|
||||||
|
|
||||||
## Collaborate with your team
|
修改完代码后，推送也是一样：
|
||||||
|
|
||||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
```
|
||||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
> git push origin dev_ck_v2.1
|
||||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
Username for 'http://47.100.68.68:3000': <输入你的gitea账户名>
|
||||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
Password for 'http://qieyuan@47.100.68.68:3000': <输入你的gitea密码>
|
||||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
```
|
||||||
|
|
||||||
## Test and Deploy
|
### 使用SSH拉取与推送（可选）：
|
||||||
|
|
||||||
Use the built-in continuous integration in GitLab.
|
【不需验证的方式】如果不想总是输入密码，可以使用SSH方式拉取和推送项目：
|
||||||
|
|
||||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
浏览器登录gitea仓库网站，右上角 `点击头像-个人设置-安全` 中上传自己的公钥即可。
|
||||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
||||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
||||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
||||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
||||||
|
|
||||||
***
|
如果本地已经指定了默认的git服务器（网上的教程一般会让github设为自己的默认服务器），
|
||||||
|
这种情况下，需要重新生成一个公钥，上传到gitea后，需要在本地（通常是C盘用户目录下的.ssh文件），`ssh config` 配置文件中，新添加一个`Host gitea` 设置：
|
||||||
|
|
||||||
# Editing this README
|
```
|
||||||
|
# 本地默认服务器
|
||||||
|
Host github.com
|
||||||
|
HostName github.com
|
||||||
|
User git
|
||||||
|
IdentityFile ~/.ssh/id_rsa_github
|
||||||
|
|
||||||
|
# 新添加一个gitea服务器，起个别名，比如gitea
|
||||||
|
Host gitea
|
||||||
|
HostName 47.100.68.68
|
||||||
|
Port 222
|
||||||
|
User git
|
||||||
|
# 这里填写自己的秘钥路径。
|
||||||
|
IdentityFile ~/.ssh/id_rsa_gitea
|
||||||
|
```
|
||||||
|
|
||||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
然后正常拉取或者提交项目，注意要使用自己别名 `gitea`
|
||||||
|
```
|
||||||
|
git clone git@gitea:BUPT/yb_arm.git
|
||||||
|
```
|
||||||
|
|
||||||
## Suggestions for a good README
|
### 编译：
|
||||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
||||||
|
|
||||||
## Name
|
在自己的linux用户配置下添加环境变量：
|
||||||
Choose a self-explaining name for your project.
|
|
||||||
|
|
||||||
## Description
|
```bash
|
||||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
vim ~/.bashrc
|
||||||
|
```
|
||||||
|
|
||||||
## Badges
|
```bash
|
||||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
# TODO YB通信相关环境
|
||||||
|
CROSS_CC_HOME=/home/qieyuan/bupt_project/yb/gcc-linaro-7.5.0-2019.12-x86_64_aarch64-linux-gnu/bin
|
||||||
|
export CROSS_CC=$CROSS_CC_HOME/aarch64-linux-gnu-
|
||||||
|
export PATH=$PATH:$CROSS_CC_HOME
|
||||||
|
```
|
||||||
|
|
||||||
## Visuals
|
加载：
|
||||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
||||||
|
|
||||||
## Installation
|
```bash
|
||||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
source ~/.bashrc
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
编译 test.52
|
||||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
|
||||||
|
|
||||||
## Support
|
```bash
|
||||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
bash build.sh --jesd --pcie --test 52
|
||||||
|
```
|
||||||
|
|
||||||
## Roadmap
|
可执行文件的输出路径：
|
||||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
||||||
|
|
||||||
## Contributing
|
```bash
|
||||||
State if you are open to contributions and what your requirements are for accepting them.
|
./build/rfic.out
|
||||||
|
./build/msgtransfer.out
|
||||||
|
```
|
||||||
|
|
||||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
### 备注：
|
||||||
|
|
||||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
udp程序在板子上运行的时候，需要放进去一个本地文件 `data.txt`
|
||||||
|
|
||||||
|
程序默认读取文件路径是绝对路径，在板子上可以放到opt路径下
|
||||||
|
|
||||||
|
```
|
||||||
|
/opt/data.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
如果想改动这个路径：
|
||||||
|
```
|
||||||
|
vim ./ucp4008_platform_arm/test/case52/src/testcase52.c
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
// 第143行
|
||||||
|
|
||||||
|
data_txt_fd = fopen("/opt/data.txt","r"); // 此处建议修改为绝对路径。
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
## Authors and acknowledgment
|
|
||||||
Show your appreciation to those who have contributed to the project.
|
|
||||||
|
|
||||||
## License
|
|
||||||
For open source projects, say how it is licensed.
|
|
||||||
|
|
||||||
## Project status
|
|
||||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user