Merge branch 'main' of https://github.com/anshulp2912/scrivener into …

…main

README.md

@@ -13,7 +13,7 @@
 ![Coverage](https://img.shields.io/badge/Coverage-97%25-red)
 ![Contributors](https://img.shields.io/badge/Contributors-5-yellowgreen)
 
-## INTRODUCTION
+## 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.
 
@@ -23,21 +23,26 @@ Scrivener is a video transcript summarizer for Youtube videos. Youtube is one of
 
 The complete development was achieved using the Python3 technology and it is recommended that the next set of developers who take up this project have these technologies installed and keep them running before proceeding further.
 
-## Steps for execution
+## Demo <a name="Demo"></a>
+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>
 1. Clone the Git repository.
 2. Run `pip install -r requirements.txt` followed by `python -c`
 3. Open Command Prompt and change the directory to the location of cloned repository.
-4. Run the command "streamlit run user_interface.py"
+4. Run the command `streamlit run user_interface.py`
 5. Next, open your browser and type in `localhost:8501` in the search bar to open the webUI of the application.
 6. The UI typically looks as shown below and here you have a choice between URL, file or normal text input.
 
-## License
-This project is licensed under the MIT License.
+## 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
+## Contributions <a name="Contributors"></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
+## 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
@@ -52,11 +57,17 @@ For enhancement of this project following functionalities can be implemented
 - Provide Sentiment Analysis of the generated summary
 - Develop a Discord BOT for SCRIVENER
 
-## Team Members
+## Team Members <a name="TeamMember"></a>
 
 - Anshul Navinbhai Patel
 - Bhavya Omprakash Agrawal
 - Darshan Manharbhai Patel
 - Pragna Bollam
 - Rohan Jigarbhai Shah
 
+## Acknowledgments <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/)

docs/proj1rubric.md

@@ -14,7 +14,7 @@ but nevertheless, here is a track record that everyone is contributing a lot)|3|
 |Docs: what: point descriptions of each class/function (in isolation) |3 |Evidence in [Software Document] (https://github.com/anshulp2912/scrivener/blob/main/docs/Project%20Documentation.pdf)|
 |Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z| 3|Evidence in [Software Document](https://github.com/anshulp2912/scrivener/blob/main/docs/Project%20Documentation.pdf)|
 |Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing|3 | Evidence in [Software Document](https://github.com/anshulp2912/scrivener/blob/main/docs/Project%20Documentation.pdf)|
-|Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.|3 |Evidence in [Youtube] |
+|Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.|3 |Evidence in [Youtube](https://www.youtube.com/watch?v=_pg9M32LiG8&ab_channel=AnshulPatel)|
 | Use of version control tools|3 | Evidence in [Requirements](https://github.com/anshulp2912/scrivener/blob/main/requirements.txt)|
 |Use of  style checkers |0 || 
 | Use of code  formatters. | 0||