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:
-[ ] [Set up project integrations](https://gitlab.engr.illinois.edu/rc18/ece445-notebook/-/settings/integrations)
## 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)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [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)
***
# Editing this README
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!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## 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
Choose a self-explaining name for your project.
## Description
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
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
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
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
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
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
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
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.
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.
## 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.
@@ -14,13 +14,9 @@ Got the guidelines for project proposal, and worked on project proposal.
...
@@ -14,13 +14,9 @@ Got the guidelines for project proposal, and worked on project proposal.
## 2/8/2024 and 2/9/2024
## 2/8/2024 and 2/9/2024
Objective is to figure out what sensors to use for our project and finish project proposal and team contract. \
Objective is to figure out what sensors to use for our project and finish project proposal and team contract. \
Started looking around for sensors, narrowed it down to pH and temperature. \
Started looking around for sensors, narrowed it down to pH and temperature. Looking for Chlorine sensors, but it is out of the budget of our project. Submitted project proposal and worked on and submitted team contract.\
Looking for Chlorine sensors, but it is out of the budget of our project. \
Submitted project proposal and worked on and submitted team contract.\
Had the intial conversation with the machine shop, to talk about our project ideas,\
Had the intial conversation with the machine shop, to talk about our project ideas, said it was possible to fabricate the dispenser and gave us ideas how we could go about it got contact information.
said it was possible to fabricate the dispenser and gave us ideas how we could go about it\
got contact information.
## 2/11/2024 and 2/12/2024
## 2/11/2024 and 2/12/2024
...
@@ -58,7 +54,7 @@ Started working on design document.
...
@@ -58,7 +54,7 @@ Started working on design document.
Objective was to finsih design document and redo project proposal. \
Objective was to finsih design document and redo project proposal. \
Finished and submitted design document. \
Finished and submitted design document. \
Redid and submitted proposal for proposal regrade.\
Redid and submitted proposal for proposal regrade.\
Got one resposne with a pH meter, but no one has access to a chlorine sensor.\
Got one resposne with a pH meter from Dr. Qi of Water Engineering department, but no one has access to a chlorine sensor.\
## 2/26/2024
## 2/26/2024
Objective is to have weekly TA meeting and provide updates. \
Objective is to have weekly TA meeting and provide updates. \
...
@@ -69,12 +65,18 @@ departments and professors.
...
@@ -69,12 +65,18 @@ departments and professors.
## 2/27/2024
## 2/27/2024
Objective is to figure out what to do about the chlorine sensor, and have a good design review. \
Objective is to figure out what to do about the chlorine sensor, and have a good design review. \
No one still had a chlorine sensor, was unsure if pH meter would work.\
No one still had a chlorine sensor, was unsure if pH meter would work.\
As it was a very expensive meter that could collect the pH value but would not be able\
Dr. Qi said pH meter he has is a WTW Handheld Meter, pH/Oxi 340i, but it is 10/15 years old. \
to integrate it into our project.\
As it was a very expensive meter that could collect the pH value but would not be able to integrate it into our project.\
Had our design review at 11am with Professor Schuh, went decently.\
Had our design review at 11am with Professor Schuh, went decently.\
Decided chlorine sensor was too expensive and too far out of the budget of the project.\
Decided chlorine sensor was too expensive and too far out of the budget of the project.\
Amazon. Amazon.Com: TDS Sensor, www.amazon.com/. Accessed 1 May 2024.
Amazon. Amazon.Com: TDS Sensor, www.amazon.com/. Accessed 1 May 2024. \
Dr. Qi also provided some other suggestions linked below, based on lab work. \
[pH Meter Manual](https://www.manualslib.com/manual/1532124/Wtw-Ph-Oxi-340i.html?page=3#manual)\
