Skip to content

Commit

Permalink
changed readme and fixed typo
Browse files Browse the repository at this point in the history
  • Loading branch information
ctih committed Jun 18, 2024
1 parent 79b8a83 commit 8dc3130
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 0 deletions.
62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,65 @@
# Momera
A program that extracts the motion from your camera.
![image](https://github.com/ctih1/Momera/assets/78687256/cf7080e4-4673-4d5c-a244-abb42b0db809)

## Introduction
This is a program that I made using python, because I was interested on motion extraction (after watching [Posy's excellent video](<https://www.youtube.com/watch?v=NSS6yAMZF78>))

## Installation
This program is very easy to setup.
* Using Git:

<ol>
<li>

```git clone https://github.com/ctih1/Momera```

</li>
<li>

```cd Momera```

</li>
<li>

```pip install -r requirements.txt```

</li>
<li>

```cd src```

</li>
<li>

```python3 main.py```

</li>
</ol>

## Usage
If you do not want to alter any settings, you can skip this section. If have issues, like the program using the wrong camera, you should follow this guide

| Key | Action
|-----|-------------------------------------------------
| Q | Quit the application
| H | Disable motion extractor to see the input video
| K | Change camera (left)
| L | Change the camera (right)
| Mousewheel Up| Alter the frame delay by +1
| Mousewheel Down | Alter the frame delay by -1

### Notifications
You may see some notifications when doing actions, or when getting errors. They are pretty self-explanatory, but on some errors, it might be hard to find a cause. Here's the most common one:
```Failed camera switch #x```
There are two reasons why this might happen:
* This camera doesn't exist.
* The camera's width or height is listed as 0

## Contribution
<ol>
<li>Clone the repo</li>
<li>Make a new branch in the following format: ("fixes" or "features")/(what you did)</li>
<li>Push your branch into GitHub</li>
<li>Make a pull request to master</li>
</ol>
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
opencv-python==4.5.5.62

0 comments on commit 8dc3130

Please sign in to comment.