first commit

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 iamyb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,36 @@
+# shotcut
+
+## Overview
+This software has been specifically developed to employ object detection and tracking techniques, enabling it to  detect and track scoring shots during basketball games.
+- Identifies and accurately detects basketballs and hoops in video frames.
+- Tracks the movement of the basketball and hoop throughout the entire video.
+- Analyzes the interaction between the basketball and the hoop, determining whether a successful scoring shot has been made.
+- Collects all scoring shot clips and combines them seamlessly into the final output video.
+
+### GUI
+[![ScreenShot](./image/screenshot.png)]
+
+### Options
+- Support to add background music and it will loop over the output video. 
+- Provide arguments to accelerate the output video.
+- Provide arguments to set the start poistion and duration of input video for processing.
+
+### Demo Output
+[![Demo Output](./image/demo_output.gif)]
+
+### Notes
+- After you click on the **start** button on the UI, you may need to wait for a while(**~1 minute**) for the software to decompress and initiate, and then you will see some progress in the processing.
+- There will be two output files after the processing. They will be located in the same directory of the input video, with the suffixes **".hit"** and **".hit_bgm"**, respectively.
+- The timestamp in the output video is inferred from the video's creation time. 
+
+## Limitations:
+- Only supports the video recorded by **stationary camera**.
+- Only available as a Windows executable binary.
+- The training dataset used contains a relatively small number of basketball court.
+- The perfomance will be degraded in other basketball court.
+
+## Credits
+I would like to express my gratitude to the PBA team (a group of amateur basketball enthusiasts) and teammates who have played basketball together with. A special thanks goes to Zhang Tao for recording the videos every time, which has enabled me to complete the initial concept validation as well as the subsequent performance benchmark. It's because of our shared passion for basketball that I have developed this.
+
+## License
+This software is licensed under the [MIT License](LICENSE).