Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dchansen06 authored Sep 19, 2024
1 parent 189ff64 commit bce6973
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,21 @@ This program is distributed in the hope that it will be useful, but WITHOUT ANY
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

# Stability
This is not yet stable or finalized software
This is not yet stable or finalized software.

Please report any bugs or security issues
Please report any bugs or security issues.

# Installation
Install the required dependencies with `sudo apt-get install libopencv-dev libclang-dev --no-install-suggests --no-install-recommends` and then install [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html).
Install the required dependencies with ```sudo apt-get install libopencv-dev libclang-dev --no-install-suggests --no-install-recommends``` and then install [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html).

Install the program with `cargo install --git https://github.com/dchansen06/mjpg-streamer/` and then run the binary (generally in `~/.cargo/bin`) with any desired flags.
Install the program with ```cargo install --git https://github.com/dchansen06/mjpg-streamer/``` and then run the binary (generally in `~/.cargo/bin`) with any desired flags.

Once completed the installation process should become a lot simpler, but this program is still well in the pre-alpha release phase, so USE WITH CAUTION AT YOUR OWN RISK.

## Security
Use at your own risk, if someone can ping your IP they can watch the stream. The apikey feature is not a replacement, it only adds a layer of [obfustication](https://en.wikipedia.org/wiki/Security_through_obscurity#Criticism).
# Security
Use at your own risk, if someone can ping your IP they can watch the stream.

The apikey feature is not a replacement, it only adds a layer of [obfustication](https://en.wikipedia.org/wiki/Security_through_obscurity#Criticism).

# To-Do
* Divide into more discrete functions
Expand Down

0 comments on commit bce6973

Please sign in to comment.