Skip to content

Update README.md #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
coder11v wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58604fd
Update README.md
coder11v Mar 17, 2026
9a41de1
Update headings in README for requirements section
coder11v Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ This project can be used to signal your robot during autonomous mode using compu

To run the program, simply install the dependencies listed below (if using Linux or Mac OS X, you can get these packages via apt or homebrew). Then, double click the cheesyvision.py icon to launch the program (if you want it to communicate with your robot, edit the source code so that it tries to connect to your teams' cRIO).

##Requirements
## Requirements

1. ####Python 2.7
1. ### Python 2.7
Copy link

@coderabbitai coderabbitai bot Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Malformed Markdown: Remove heading syntax from list items.

Combining numbered list syntax (1., 2., 3.) with heading syntax (###) is invalid Markdown. This structure will render inconsistently across different Markdown parsers and violates standard Markdown specifications.

Since these are requirement items under a "Requirements" section, they should be formatted as plain numbered list items without heading markers.

📝 Proposed fix to use proper numbered list syntax 
-1. ### Python 2.7
+1. **Python 2.7**
   - Installers found at: https://www.python.org/download/
   - 32 bit: https://www.python.org/ftp/python/2.7.6/python-2.7.6.msi
   - 64 bit: https://www.python.org/ftp/python/2.7.6/python-2.7.6.amd64.msi

-2. ### Numpy
+2. **Numpy**
   - Installers found at: http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy
   - 32 bit: https://www.dropbox.com/s/aeusld7lffrawgy/numpy-MKL-1.8.1.win32-py2.7.exe
   - 64 bit: https://www.dropbox.com/s/qzezri6zlteozqe/numpy-MKL-1.8.1.win-amd64-py2.7.exe

-3. ### OpenCV
+3. **OpenCV**
   - Installers found at: http://www.lfd.uci.edu/~gohlke/pythonlibs/#opencv
   - 32 bit: https://www.dropbox.com/s/lb3kkrht0g63nkc/opencv-python-2.4.8.1.win32-py2.7.exe
   - 64 bit: https://www.dropbox.com/s/t6qs8yde326grf4/opencv-python-2.4.8.1.win-amd64-py2.7.exe

Note: Using bold text (**) for emphasis within list items maintains visual hierarchy while keeping valid Markdown structure.

Also applies to: 15-15, 20-20

🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 10-10: Heading style
Expected: setext; Actual: atx

(MD003, heading-style)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 10, The list items like "### Python 2.7" (and the similar
lines for the other entries) are using heading syntax inside a numbered list;
remove the "###" heading markers and convert them into plain numbered list items
(e.g., "1. Python 2.7") keeping any emphasis (bold) as needed, so the
Requirements section uses valid numbered list syntax instead of mixed
heading/list markup.

- Installers found at: https://www.python.org/download/
- 32 bit: https://www.python.org/ftp/python/2.7.6/python-2.7.6.msi
- 64 bit: https://www.python.org/ftp/python/2.7.6/python-2.7.6.amd64.msi

2. ####Numpy
2. ### Numpy
- Installers found at: http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy
- 32 bit: https://www.dropbox.com/s/aeusld7lffrawgy/numpy-MKL-1.8.1.win32-py2.7.exe
- 64 bit: https://www.dropbox.com/s/qzezri6zlteozqe/numpy-MKL-1.8.1.win-amd64-py2.7.exe

3. ####OpenCV
3. ### OpenCV
- Installers found at: http://www.lfd.uci.edu/~gohlke/pythonlibs/#opencv
- 32 bit: https://www.dropbox.com/s/lb3kkrht0g63nkc/opencv-python-2.4.8.1.win32-py2.7.exe
- 64 bit: https://www.dropbox.com/s/t6qs8yde326grf4/opencv-python-2.4.8.1.win-amd64-py2.7.exe
Expand Down