gilles/cameradar
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve README.md

Browse Source
This commit is contained in:
Brendan LE GLAUNEC
2016-05-20 13:43:28 +02:00
committed by Brendan Le Glaunec
parent 29f05e0b70
commit 780a32d706
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -4
View File
@@ -38,7 +38,7 @@ Of course, you can also call for individual tasks if you plug in a Database to C
## Quick install ## Quick install
The quick install uses docker to build Cameradar without polluting your machine with dependencies and makes it easy to deploy Cameradar in a few commands. *However, it may require networking knowledge, as your docker containers will need access to the cameras subnetwork.* The quick install uses docker to build Cameradar without polluting your machine with dependencies and makes it easy to deploy Cameradar in a few commands. **However, it may require networking knowledge, as your docker containers will need access to the cameras subnetwork.**
### Dependencies ### Dependencies
@@ -46,7 +46,7 @@ The only dependencies are `docker` and `docker-compose`.
### Five steps guide ### Five steps guide
1. `https://github.com/EtixLabs/cameradar.git` 1. `git clone https://github.com/EtixLabs/cameradar.git`
2. Go into the Cameradar repository, then to the `deployment` directory 2. Go into the Cameradar repository, then to the `deployment` directory
3. Tweak the `conf/cameradar.conf.json` as you need (see [the onfiguration guide here](#configuration) for more information) 3. Tweak the `conf/cameradar.conf.json` as you need (see [the onfiguration guide here](#configuration) for more information)
4. Run `docker-compose build cameradar` to build the cameradar container 4. Run `docker-compose build cameradar` to build the cameradar container
@@ -71,7 +71,7 @@ To install Cameradar you will need these packages
The simplest way would be to follow these steps : The simplest way would be to follow these steps :
1. `https://github.com/EtixLabs/cameradar.git` 1. `git clone https://github.com/EtixLabs/cameradar.git`
2. Go into the Cameradar repository, create a directory named `build` and go in it 2. Go into the Cameradar repository, create a directory named `build` and go in it
3. In the build directory, run `cmake ..` This will generate the Makefiles you need to build Cameradar 3. In the build directory, run `cmake ..` This will generate the Makefiles you need to build Cameradar
4. Run the command `make` 4. Run the command `make`
@@ -206,7 +206,7 @@ If you have other cool ideas, feel free to share them with me at brendan.leglaun
## Next improvements ## Next improvements
- [x] Add a docker deployment to avoid the current deps hell - [x] Add a docker deployment to avoid the current deps hell
- [ ] Development of a MySQL cache manager - [x] Development of a MySQL cache manager
- [ ] Development of a JSON file cache manager - [ ] Development of a JSON file cache manager
- [ ] Development of an XML file cache manager - [ ] Development of an XML file cache manager