Skip to content

Commit

Permalink
docs: added install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tbouasli committed Apr 17, 2024
1 parent 4037807 commit d83162c
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,28 @@
<img src="https://github.com/ThomasBouasli/cat_toy/actions/workflows/lint.yaml/badge.svg" alt="Lint Badge">
</div>

## Descrição

O Cat Toy é um brinquedo para gatos que utiliza um laser para entreter o gato. O brinquedo é controlado por um raspberry pi que identifica o gato na camera e move o laser para que o gato se mova.

## Instalação

Para instalar o projeto, você precisa clonar o repositório e instalar as dependências.

```bash
git clone https://github.com/4SIR/cat_toy.git
cd cat_toy
pip install -r requirements.txt
```

## Uso

Para rodar o projeto, você precisa rodar o arquivo `main.py`.

```bash
python main.py
```

## Definição de Pronto

- [ ] Identificar um gato na camera (1,0)
Expand Down

0 comments on commit d83162c

Please sign in to comment.