UniTrackApp/scanner

Update README with updated information

Closed this issue · 1 comments

Main things I'd like to add:

1. Setting up virtual Python environment

Include instructions to create a venv so users don't install to their system Python interpreter.

python -m venv my-venv creates a folder called my-venv and running source /my-venv/bin/activate will activate their venv instance. All dependencies should be installed inside my-venv ideally. Just make sure these commands work on your computer and you may rewrite these in your own words )

PS: I just wrote my-venv for example sake. Typically people call that folder venv or .venv, benefit of .venv is that folder becomes hidden by default.

2. Dependencies Installation

Mention how we can use pip install -r requirements.txt instead of installing dependencies manually.

3. Updated info on what parts we use, etc

  • Information like what LED we're using, what RFID sensor model we used
  • Quick guide to how we connected them
  • GPIO pins we used
  • And more info like that

@Bosurgi Thoughts on this? Anything else we'd like to add?

Drop thoughts here and then when ready you can make the updates sometime later. Not a priority rn.