Skip to content

Commit

Permalink
Chores: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ppodds committed Dec 29, 2021
1 parent eb1dd6c commit a16059d
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 6 deletions.
6 changes: 3 additions & 3 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@
#
# image files are treated as binary by default.
###############################################################################
#*.jpg binary
#*.png binary
#*.gif binary
*.jpg binary
*.png binary
*.gif binary

###############################################################################
# diff behavior for common document formats
Expand Down
42 changes: 39 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,45 @@

## About

This is a term project of Assembly Language and System Programming course in NCU. It decode video with FFmpeg and plays ASCII animation with assembly.
This is a term project of the Assembly Language and System Programming course in NCU. It decodes video with FFmpeg and plays ASCII animation with assembly. The graphic media player is implemented with Qt's QMediaPlayer and QVideoWidget.

## Screenshots

![](docs/screenshot_1.png)
![](docs/screenshot_2.png)
![](docs/screenshot_3.png)
![](docs/screenshot_4.png)

## Installation

### Envirment
### Use Prebuilt Binary

1. Install FFmpeg and add your ffmpeg bin to `PATH`
2. Download prebuilt binary from [here](https://github.com/ppodds/AAAAnimation/releases)

Caution:
Prebuilt binary conains Qt6's dependency, but you need to install FFmpeg by yourself.

### Compile From Source Code

#### Envirment

- Visual Studio 2019
- Universal Windows Platform
- C++ Desktop
- Windows 10 SDK (10.0.1904)
- Build Tools v142
- Qt VS Tools (Extension)
- FFmpeg
- [ffmpeg-n4.4.1-2-gcc33e73618-win64-lgpl-shared-4.4](https://github.com/BtbN/FFmpeg-Builds/releases)
- Qt
- msvc 6.2.2
- Windows

### Clone The Repository and Set Environment Variables
Caution:
you need to set Qt VS Tools's Qt Version to "Qt 6.2.2 for MSVC 2019"

#### Clone The Repository and Set Environment Variables

```shell
git clone https://github.com/ppodds/AAAAnimation.git
Expand All @@ -33,3 +54,18 @@ Environment Variables
- `%your_qt_path%`
- PATH
- `%qt%\bin;%ffmpeg%\bin%;...`

#### Build

Open `AAAAnimation.sln` and select build configuation (`Release`). Then build solution. You can see the result in `AAAAnimation\x64\Release\AAAAnimation.exe`.

If you want to deploy the binary, you can use qt's `windeployqt` tool in qt's console.

Change directory to `AAAAnimation\x64\Release` and run `windeployqt`

usage: `windeployqt AAAAnimation.exe`

This tool will copy dependencies to that folder and generate some files for deployment. Now you can run `AAAAnimation.exe` and enjoy it.

Caution:
`windeployqt` will not copy FFmpeg's dependencies to this folder. You need to copy them manually or add them to `PATH`.
Binary file added docs/screenshot_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshot_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshot_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshot_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a16059d

Please sign in to comment.