Skip to content

Commit

Permalink
new: Release notes and changelog
Browse files Browse the repository at this point in the history
Keep track of changelog over releases. Also added notes on how to
prepare a release image.
  • Loading branch information
reinzor committed Feb 17, 2019
1 parent fa07430 commit 4056140
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitchangelog.rc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
output_engine = mustache("markdown")
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog

## 0.1 (2019-02-15)

### New

* Added time and ip overlay for testing purposes [Rein Appeldoorn]

* Web server for distributing video files and starting/stopping videos [Rein Appeldoorn]

* Videocrop configs per client [Rein Appeldoorn]

* Synchronized playback on multiple clients with central time server [Rein Appeldoorn]
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,34 @@ Cost `~15 USD` per client

This is automatically started on a raspberry pi after installation. Can be manually started on an ubuntu x86 environment.

### How to create release image

- Create a git tag and update release notes
- Ensure new MAC generation on startup

```bash
sudo rm -f /etc/network/mac
```

- Create `.img` file on Ubuntu host computer (insert sd card):

```bash
sudo fdisk -l # Get the disk name of the sd card
sudo dd bs=4M if=/path/to/disk of=/path/to/image.img
```

- Shrink the image using [pishrink.sh](https://raw.githubusercontent.com/Drewsif/PiShrink/master/pishrink.sh)

```bash
sudo ./pishrink.sh /path/to/image.img /path/to/shrinked_image.img
```

- Create a `tar.gz` from image file:

```
Right click, compress, tar.gz
```

## References

- [Cinder GST Sync Player](https://github.com/patrickFuerst/Cinder-GstVideoSyncPlayer)
Expand Down
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@ tqdm==4.26.0
pymediainfo==2.3.0
colorlog==3.1.4
tornado==5.1.1
gitchangelog==3.0.4
pystache==0.5.4

0 comments on commit 4056140

Please sign in to comment.