Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rohan22shah authored Oct 1, 2021
1 parent a7a5459 commit 259cb39
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,17 @@
![Contributors](https://img.shields.io/badge/Contributors-5-yellowgreen)
[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/watch?v=_pg9M32LiG8&ab_channel=AnshulPatel)

## INTRODUCTION <a name="Introduction"></a>
## Table of Contents
- [Introduction](#Introduction)
- [Demo](#Demo)
- [Steps for Execution](#ExecutionSteps)
- [License](#License)
- [Contributions](#Contributions)
- [Future Scope](#FutureScope)
- [Team Members](#TeamMember)
- [Acknowledgements](#Acknowledgement)

## Introduction <a name="Introduction"></a>

Scrivener is a video transcript summarizer for Youtube videos. Youtube is one of the most used website. A lot of people use the captions to understand the language of the video. In our project we aim to create a transcript summarizer which accepts a youtube URL link, collects the caption at every sentence and then provides the summary of the complete video. Our goal is to make the summarizer as accurate as possible and to add various other features. Our second goal of the project is to create a summarizer which can summarize the youtube videos which have captions disabled. Our project can be further expanded for numerous applications. This document provides a major perspective for the users to understand and take up the project as an Open source software and add on multiple features. Also, the document aids the developers in understanding the code and acts as a reference point for starting the project.

Expand All @@ -29,7 +39,7 @@ The project is deployed on both Streamlit cloud and Heroku.
- [Streamlit](https://share.streamlit.io/anshulp2912/scrivener/main/source/scrivener_user_interface.py)
- [Heroku](https://scrivener-heroku.herokuapp.com/)

## Steps for execution <a name="ExecutionSteps"></a>
## Steps for Execution <a name="ExecutionSteps"></a>
1. Clone the Git repository.
2. Run `pip install -r requirements.txt`
3. Open Command Prompt and change the directory to the location of cloned repository.
Expand All @@ -42,10 +52,10 @@ The project is deployed on both Streamlit cloud and Heroku.
## License <a name="License"></a>
This project is licensed under the terms of the MIT license. Please check [License](https://github.com/anshulp2912/scrivener/blob/main/LICENSE) for more details.

## Contributions <a name="Contributors"></a>
## Contributions <a name="Contributions"></a>
Please see our [CONTRIBUTING.md](https://github.com/anshulp2912/scrivener/blob/main/CONTRIBUTING.md) for instructions on how to contribute to the project by completing some of the issues.

## FUTURE SCOPE <a name="FutureScope"></a>
## Future Scope <a name="FutureScope"></a>
For enhancement of this project following functionalities can be implemented
- Currently our application supports youtube videos and videos with .mp4 extension. Provide support for other video formats
- Perform summarization for videos in languages other than English
Expand All @@ -68,9 +78,10 @@ For enhancement of this project following functionalities can be implemented
- Pragna Bollam
- Rohan Jigarbhai Shah

## Acknowledgments <a name="Acknowledgement"></a>
## Acknowledgements <a name="Acknowledgement"></a>
We would like to thank Professor Dr Timothy Menzies for helping us understand the process of building a good Software Engineering project. We would also like to thank the teaching assistants Xiao Ling, Andre Lustosa, Kewen Peng, Weichen Shi for their support throughout the project.
- [https://streamlit.io/](https://streamlit.io/)
- [https://huggingface.co/](https://huggingface.co/)
- [https://shields.io/](https://shields.io/)
- [https://www.powtoon.com/](https://www.powtoon.com/)
- [https://www.heroku.com/](https://www.heroku.com/)

0 comments on commit 259cb39

Please sign in to comment.