Skip to content
Snippets Groups Projects
Commit 9ed8c0a1 authored by Seung Hun Han's avatar Seung Hun Han
Browse files

Update README

parent d035c7ed
No related branches found
No related tags found
No related merge requests found
# final ### RP #1 (Master Sub Device : LCD, Buzzer, Vibrator, Button, RF Module)
> **Files : “gpio.h”, “lcd.h”, “vibration_motor.c”**
>
GPIO의 세팅은 끝났다는 전제 하에, 추가 라이브러리 wiringpi 설치 후 실행
## Getting started 아래의 과정을 통해서 gettingstarted 파일을 만들었다.
To make it easy for you to get started with GitLab, here's a list of recommended next steps. seunghunhan@raspberrypi:~/Desktop/Project $ wget h[ttp://tmrh20.github.io/RF24Installer/RPi/install.sh](http://tmrh20.github.io/RF24Installer/RPi/install.sh)
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)! seunghunhan@raspberrypi:~/Desktop/Project $ chmod +x [install.sh](http://install.sh/)
## Add your files seunghunhan@raspberrypi:~/Desktop/Project $ cd rf24libs/RF24/examples_linux
- [ ] [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 위의 경로 안에 있는 gettingstarted.cpp 파일을 본 프로젝트의 목적에 맞게 수정하여 빌드.
- [ ] [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:
``` seunghunhan@raspberrypi:~/Desktop/Project/rf24libs/RF24/examples_linux $ make
cd existing_repo
git remote add origin https://git.ajou.ac.kr/sp_2023_spring_shiba/final.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools seunghunhan@raspberrypi:~/Desktop/Project $ sudo apt-get install wiringpi
- [ ] [Set up project integrations](https://git.ajou.ac.kr/sp_2023_spring_shiba/final/-/settings/integrations) seunghunhan@raspberrypi:~/Desktop/Project $ gcc -o vib vibration_motor.c -lpthread -lwiringPi -lm
## Collaborate with your team seunghunhan@raspberrypi:~/Desktop/Project $ ./vib {RP #2의 IP} {RP #2의 PORT = 8885}
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) ### RP #2 (Master Main Device : GPS) - folder name (master_gps)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy > **Files : “gps.py” “Master_GPS.c”**
>
Use the built-in continuous integration in GitLab. GPIO의 세팅은 끝났다는 전제 하에, 추가 라이브러리 wiringpi 설치 후 실행
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) pi@raspberrypi:~/Desktop/Project $ sudo apt-get update
- [ ] [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)
*** pi@raspberrypi:~/Desktop/Project $ sudo apt-get install python3.6
# Editing this README pi@raspberrypi:~/Desktop/Project $ gcc -o ./main Master_GPS.c -lpthread -lm
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. pi@raspberrypi:~/Desktop/Project $ ./main
## Suggestions for a good README ### RP #3 (반려 동물 측 sub 장치 : Camera, RF Module) - folder name (camera)
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 > **Files : “camera.c”**
Choose a self-explaining name for your project. >
## Description 아래의 과정을 통해서 gettingstarted 파일을 만들었다.
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.
## Badges admin12@raspberrypi:~/Documents/main $ wget h[ttp://tmrh20.github.io/RF24Installer/RPi/install.sh](http://tmrh20.github.io/RF24Installer/RPi/install.sh)
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.
## Visuals admin12@raspberrypi:~/Documents/main $ chmod +x install.sh
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 admin12@raspberrypi:~/Documents/main $ cd rf24libs/RF24/examples_linux
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.
## Usage 위의 경로 안에 있는 gettingstarted.cpp 파일을 본 프로젝트의 목적에 맞게 수정하여 빌드.
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 admin12@raspberrypi:~/Documents/main/rf24libs/RF24/examples_linux $ make
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.
## Roadmap GPIO의 세팅은 끝났다는 전제 하에, 추가 라이브러리 wiringpi 설치 후 실행
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing admin12@raspberrypi:~/Documents/main $ sudo apt-get update
State if you are open to contributions and what your requirements are for accepting them.
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. admin12@raspberrypi:~/Documents/main $ gcc camera_main.c -o camera -lpthread
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. admin12@raspberrypi:~/Documents/main $ ./camera
## Authors and acknowledgment ### RP #4 (반려 동물 측 main 장치 : Heartbeat Sensor, GPS Module) - folder name (pet_main)
Show your appreciation to those who have contributed to the project.
## License > **Files : “main” “Raspberry-Pi-Heartbeat-Pulse-Sensor” “pet_main.c” “GPS/gps.py”
For open source projects, say how it is licensed. Library Folder - {“Raspberry-Pi-Heartbeat-Pulse-Sensor”} : {”**[pulsesensor.py](http://pulsesensor.py/)”, “[MCP3008.py](http://mcp3008.py/)”, “[example.py](http://example.py/)”**}**
>
## Project status mueg12@raspberrypi:~/mueg12/main $ sudo apt-get update
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.
mueg12@raspberrypi:~/mueg12/main $ sudo apt-get install python3.6
mueg12@raspberrypi:~/mueg12/main $ gcc main.c -o main -lpthread
mueg12@raspberrypi:~/mueg12/main $ ./main
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment