Setup the README file!
This commit is contained in:
32
README.md
32
README.md
@@ -1,3 +1,33 @@
|
||||
# Calscan
|
||||
|
||||
A food scanning system that provides real-time nutritional information, running in Docker and updating automatically from a central Git repository.
|
||||
A food scanning system that provides real-time nutritional information, running in Docker and updating automatically from a central Git repository.
|
||||
|
||||
Calscan was made for the [Raspberry Pi PA Consulting Competition](https://www.paconsulting.com/culture/pa-in-the-community/raspberry-pi-competition-uk)
|
||||
|
||||
## Features
|
||||
- Scan food items via barcode input.
|
||||
- Retrieve nutritional information instantly.
|
||||
- Automatic updates via Git.
|
||||
- Runs in Docker for reproducibility and easy deployment.
|
||||
- Designed for scalability on Raspberry Pi or cloud environments.
|
||||
|
||||
## Setup
|
||||
1. **Install Docker on your Pi**
|
||||
```bash
|
||||
curl -fsSL https://get.docker.com -o get-docker.sh
|
||||
sh get-docker.sh
|
||||
```
|
||||
|
||||
2. **Clone our Repository**
|
||||
```bash
|
||||
git clone https://code.calscan.co.uk/calscan/Calscan
|
||||
cd Calscan
|
||||
```
|
||||
|
||||
3. **Build and run Docker container**
|
||||
```bash
|
||||
docker build -t calscan .
|
||||
docker run -d --name calscan calscan
|
||||
```
|
||||
|
||||
**You can view the rest of the information at [calscan.co.uk](https://calscan.co.uk)**
|
||||
Reference in New Issue
Block a user