Skip to content

Commit f9191d5

Browse files
authored
Update README (#196)
2 parents e48a32b + d51e734 commit f9191d5

File tree

1 file changed

+41
-36
lines changed

1 file changed

+41
-36
lines changed

README.md

Lines changed: 41 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,42 @@
1515
</div>
1616

1717

18-
## License
19-
20-
[![](https://camo.githubusercontent.com/317e8956b95d7cd7ebdc2a75b836f19dee3c1ae5fa0fce5b277338e648880d4f/68747470733a2f2f7777772e676e752e6f72672f67726170686963732f67706c76332d3132377835312e706e67)](https://www.gnu.org/licenses/gpl-3.0.en.html)
21-
22-
Copyright © 2022, [Bluecherry DVR](https://www.bluecherrydvr.com/).
18+
## Features
2319

24-
This project & work under this repository is licensed under [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
20+
* 🖲️ Ability to add multiple [Bluecherry DVR servers](https://www.bluecherrydvr.com/downloads/).
21+
* 📺 Play any stream or recording from the web.
22+
* 🎛️ Interactive camera grid viewer, with support for multiple layouts:
23+
<br /> $~~~~$
24+
💻 For larger screens, compact and multiple layout views are available.
25+
<br /> $~~~~~$📱 For smaller screens, see multiple cameras in 2x3, 2x2, 2x1 or 1x1 view
26+
<br /> $~~~~~$👆 Re-orgderable drag-and-drop camera viewer
27+
<br /> $~~~~~$🛞 Cycle through different layout views automatically
28+
* 🔎 Pinch-to-zoom fullscreen camera viewer.
29+
* 📹 Multicast streams support
30+
* 🏃 Events List Viewer
31+
* 🚡 Events Timeline Viewer
32+
* 📸 Direct camera viewer.
33+
* 🎮 **P**an-**T**ilt-**Z**oom controls for supported cameras.
34+
* 🌓 Light & dark app theme.
35+
* 📰 System camera event notifications.
36+
* 📺 Adaptive and responsive design for larger screens
37+
* 📱 Cross-platform
38+
<br /> $~~~~$📱 Mobile: Android & iOS
39+
<br /> $~~~~$🖥️ Desktop: Windows, Linux & MacOS
40+
* 📦 Automatic updates
2541

2642

2743
## Download
2844

2945
| Android | iOS | Windows | GNU/Linux | MacOS |
3046
| ------- | --- | ------- | ----- | ----- |
31-
| [arm64 `.apk`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-android-arm64-v8a-release.apk) | [App Store](https://apps.apple.com/us/app/bluecherry-mobile/id1555805139) | [Windows Setup](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-windows-setup.exe) | [AppImage](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/Bluecherry-latest.AppImage) | 🚧 **SOON** ~~[App Store](https://github.com/bluecherrydvr/unity/issues/112)~~ |
32-
| [armabi `.apk`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-android-armeabi-v7a-release.apk) | | 🚧 **SOON** ~~`winget install bluecherry`~~ | [Ubuntu/Debian `.deb`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-linux-x86_64.deb) | [Executable `.app`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-macos.7z) |
47+
| [arm64 `.apk`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-android-arm64-v8a-release.apk) | [App Store](https://apps.apple.com/us/app/bluecherry-mobile/id1555805139) | [Windows Setup](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-windows-setup.exe) | [AppImage](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-linux-x86_64.AppImage) | [Executable `.app`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-macos.7z) |
48+
| [armabi `.apk`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-android-armeabi-v7a-release.apk) | | 🚧 **SOON** ~~`winget install bluecherry`~~ | [Ubuntu/Debian `.deb`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-linux-x86_64.deb) | 🚧 **SOON** ~~[App Store](https://github.com/bluecherrydvr/unity/issues/112)~~ |
3349
| [x86_64 `.apk`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-android-x86_64-release.apk) | | 🚧 **SOON** ~~Microsoft Store~~ | [Raw Executable `.tar.gz`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-linux-x86_64.tar.gz) | |
3450
| 🚧 **SOON** ~~Play Store~~ | | | [Fedora/Red Hat Linux `.rpm`](https://github.com/bluecherrydvr/unity/releases/download/bleeding_edge/bluecherry-linux-x86_64.rpm) | |
3551

52+
Or download the latest release [here](https://github.com/bluecherrydvr/unity/releases).
53+
3654
### Installation
3755

3856
Most platforms will not require any extra steps to install the app.
@@ -50,29 +68,21 @@ sudo dpkg -i bluecherry-linux-x86_64.deb
5068
```
5169

5270

53-
## Features
71+
## License
5472

55-
* 🖲️ Ability to add multiple [Bluecherry DVR servers](https://www.bluecherrydvr.com/downloads/).
56-
- 🎛️ Interactive camera grid viewer, with support for multiple layouts:
57-
<br /> $~~~~$
58-
💻 For larger screens, compact and multiple layout views are available.
59-
<br /> $~~~~~$📱 For smaller screens, see multiple cameras in 2x3, 2x2, 2x1 or 1x1 view
60-
<br /> $~~~~~$👆 Re-orgderable drag-and-drop camera viewer
61-
<br /> $~~~~~$🛞 Cycle through different layout views automatically
62-
* 🔎 Pinch-to-zoom fullscreen camera viewer.
63-
* 🏃 Events List Viewer
64-
* 🚡 Events Timeline Viewer
65-
* 📸 Direct camera viewer.
66-
* 🎮 Pan-Tilt-Zoom controls for supported cameras.
67-
* 🌓 Consistent & configurable system-aware, light & dark app theme.
68-
* ⏲️ Configurable in-app date & time format.
69-
* 📰 System camera event notifications with screenshot thumbnails.
70-
* ⏰ Ability to snooze notifications directly from notification or within the app.
71-
* 📺 Adaptive and responsive design for larger screens
72-
* 🕸️ Directionality support for right-to-left languages
73-
* 📱 Cross-platform
73+
[![](https://camo.githubusercontent.com/317e8956b95d7cd7ebdc2a75b836f19dee3c1ae5fa0fce5b277338e648880d4f/68747470733a2f2f7777772e676e752e6f72672f67726170686963732f67706c76332d3132377835312e706e67)](https://www.gnu.org/licenses/gpl-3.0.en.html)
74+
75+
Copyright © 2022, [Bluecherry DVR](https://www.bluecherrydvr.com/).
76+
77+
This project & work under this repository is licensed under [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
78+
79+
## Bug-Reports
80+
81+
Send us details about any issues you discover [in the issues](https://github.com/bluecherrydvr/unity/issues) or [in the forums](https://forums.bluecherrydvr.com/).
82+
83+
## Contribute
7484

75-
## Translate
85+
### Translate
7686

7787
You may provide translations for the application to see it running in your own language. Please follow these steps:
7888

@@ -85,18 +95,14 @@ Let's say, we're adding French (`fr`) translation.
8595

8696
When adding new strings, run `bin/l10n_organizer.dart`. This script will ensure that the new strings are added to all l10n files and that they are in the same location. It will also remove any unused strings. The base file is `app_en.arb`, so all strings must be added there first.
8797

88-
## Bug-Reports
89-
90-
Send us details about any issues you discover [in the issues](https://github.com/bluecherrydvr/unity/issues) or [in the forums](https://forums.bluecherrydvr.com/).
98+
Note that the app is constantly changing and new strings are added all the time. The translations need to be updated constantly.
9199

92-
## Contribute & Technical Review
100+
### Technical Details
93101

94102
The code uses [Provider](https://github.com/rrousselGit/provider) for state-management because it is widely known by Flutter community, doesn't bring any unnecessary complexity to the codebase & is scalable/stable enough.
95103

96104
Most `ChangeNotifier`s are available as singletons, though de-coupled from each other. This is important to handle things like loading app configuration before `runApp`, handling background notification button actions & few other asynchronous operations performed outside the widget tree. By having singletons, we are able to avoid a strict dependency on the `BuildContext` & do certain things in a more performant way.
97105

98-
Everything is well-documented (e.g. [this](https://github.com/bluecherrydvr/unity/blob/fce2aad3213298f70e91eb549a71699826e5c6e4/lib/providers/mobile_view_provider.dart#L28-L35)). Other important comments & work-arounds may be found throughout the code.
99-
100106
Current source tree has following files:
101107

102108
```
@@ -151,7 +157,6 @@ The build process is pretty straight-forward. You need to have [Flutter](https:/
151157
git clone https://github.com/bluecherrydvr/unity
152158
cd unity
153159
flutter pub get
154-
flutter gen-l10n
155160
flutter build [linux|windows|macos|android|ios]
156161
```
157162

0 commit comments

Comments
 (0)