Skip to content

Commit

Permalink
Updates more readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
lucashicks1 committed Oct 15, 2023
1 parent 11d101c commit 846c36d
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
22 changes: 21 additions & 1 deletion build/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
# BUILD
Build code goes here when project underway
## Build Instructions in order of process

## Initial Environment Setup
Our project relies on several different libraries in order for it to function. As most of our project is written in Python, there is an [`environment.yaml`](https://github.com/lucashicks1/lambda-deco3801/blob/main/environment.yaml) file that has been created, allowing you to create your own conda virtual environment. You can create and activate this environment with the following:

```
conda env create -f environment.yaml
conda activate lambda-env
```
Or you can create your own environment and install the packages with

```
conda create -n your_env_name
conda activate your_env_name
conda install numpy pillow pytesseract matplotlib pymongo requests
conda install -c conda-forge fastapi pydantic uvicorn-standard
pip install opencv-python-headless
```

Once this environment is setup, all the needed dependencies for our python components should be installed.

## Build Instructions for each project component
1. [Database](../build/db-handler/README.md)
2. [Camera](../build/vision/README.md)
3. [Display](../build/ui-display/frontend-app/README.md)
Expand Down
2 changes: 1 addition & 1 deletion build/figurines/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Microcontroller Communications
1. Connect the Seeduino Xiao to a serial port using provided USB-C to USB-A cable
2. Double click the .bat file located in this directory
2. Double click the [`microcontroller_communications.bat`](https://github.com/lucashicks1/lambda-deco3801/blob/main/build/figurines/microcontroller_communications.bat) file located in this directory
3. The file will download all required python libraries, so please wait for it to finish
4. The program will run on completion of installations

0 comments on commit 846c36d

Please sign in to comment.