Update README.md

README.md

@@ -1,77 +1,39 @@
----
-title: SlideDeck AI
-emoji: 🏢
-colorFrom: yellow
-colorTo: green
-sdk: streamlit
-sdk_version: 1.32.2
-app_file: app.py
-pinned: false
-license: mit
----
+# AI-SlideMaker
 
-# SlideDeck AI
+We spend a lot of time creating slides and organizing our thoughts for presentations. With AI-SlideMaker, you can co-create slide decks on any topic using Generative Artificial Intelligence. Describe your topic, and let AI-SlideMaker generate a PowerPoint slide deck for you—it's that simple!
 
-We spend a lot of time on creating the slides and organizing our thoughts for any presentation. 
-With SlideDeck AI, co-create slide decks on any topic with Generative Artificial Intelligence.
-Describe your topic and let SlideDeck AI generate a PowerPoint slide deck for you—it's as simple as that!
+AI-SlideMaker is powered by [Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407).
 
-SlideDeck AI is powered by [Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407).
-Originally, it was built using the Llama 2 API provided by Clarifai.
+## Update (v4.0)
 
-*Update (v4.0)*: Legacy SlideDeck AI allowed one-shot generation of a slide deck based on the inputs. 
-In contrast, SlideDeck AI *Reloaded* enables an iterative workflow with a conversational interface,
-where you can create and improve the presentation.
+- Legacy AI-SlideMaker allowed one-shot generation of slide decks based on inputs.
+- AI-SlideMaker *Reloaded* enables an iterative workflow with a conversational interface, allowing you to create and refine presentations interactively.
 
+## Process
 
-# Process
+AI-SlideMaker works in the following way:
 
-SlideDeck AI works in the following way:
+1. **Initial Slide Generation**: Given a topic description, AI-SlideMaker uses Mistral-Nemo-Instruct to generate the *initial* content of the slides. The output is generated as structured JSON data based on a pre-defined schema.
+2. **Image Search**: Using keywords from the JSON output, it searches and downloads relevant images with a certain probability.
+3. **Slide Creation**: It uses the `python-pptx` library to generate slides based on the JSON data. Users can choose from three pre-defined presentation templates.
+4. **Refinement**: Users can provide additional instructions to *refine* the content, such as adding new slides or modifying existing ones.
+5. **Download**: Each time a presentation is generated, a download button is provided for users to download the PowerPoint file.
 
-1. Given a topic description, it uses Mistral Nemo Instruct to generate the *initial* content of the slides. 
-The output is generated as structured JSON data based on a pre-defined schema.
-2. Next, it uses the keywords from the JSON output to search and download a few images with a certain probability.
-3. Subsequently, it uses the `python-pptx` library to generate the slides, 
-based on the JSON data from the previous step. 
-A user can choose from a set of three pre-defined presentation templates.
-4. At this stage onward, a user can provide additional instructions to *refine* the content.
-For example, one can ask to add another slide or modify an existing slide.
-A history of instructions is maintained.
-5. Every time SlideDeck AI generates a PowerPoint presentation, a download button is provided.
-Clicking on the button will download the file.
+## Known Issues
 
+- **Connection timeout**: Requests sent to the Hugging Face Inference endpoint might time out. If this happens, try again later.
+- **Text Input Limit**: If the pasted text exceeds the maximum number of characters allowed in the input box, it will not paste correctly.
 
-# Icons
+## Local Development
 
-SlideDeck AI uses a subset of icons from [bootstrap-icons-1.11.3](https://github.com/twbs/icons)
- (MIT license) in the slides. A few icons from [SVG Repo](https://www.svgrepo.com/)
-(CC0, MIT, and Apache licenses) are also used. 
+To run this project locally, you need to provide the following API keys:
 
+- `HUGGINGFACEHUB_API_TOKEN`: To use the Hugging Face Inference API.
+- `PEXEL_API_KEY`: To search and download images.
 
-# Known Issues
+Add these keys to your environment variables or a `.env` file. Visit the respective websites to obtain these API keys.
 
-- **Connection timeout**: Requests sent to the Hugging Face Inference endpoint might time out. If it still does not work, wait for a while and try again.
 
-The following is not an issue but might appear as a strange behavior:
-- **Cannot paste text in the input box**: If the length of the copied text is greater than the maximum
-number of allowed characters in the textbox, pasting would not work.
+## Acknowledgment
 
-
-# Local Development
-
-SlideDeck AI uses [Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407) 
-via the Hugging Face Inference API.
-To run this project by yourself, you need to provide the `HUGGINGFACEHUB_API_TOKEN` API key,
-for example, in a `.env` file. For image search, the `PEXEL_API_KEY` should be added. 
-Visit the respective websites to obtain the keys.
-
-
-# Live Demo
-
-- [SlideDeck AI](https://huggingface.co/spaces/barunsaha/slide-deck-ai) on Hugging Face Spaces
-- [Demo video](https://youtu.be/QvAKzNKtk9k) of the chat interface on YouTube
-
-
-# Award
-
-SlideDeck AI has won the 3rd Place in the [Llama 2 Hackathon with Clarifai](https://lablab.ai/event/llama-2-hackathon-with-clarifai) in 2023.
+This is the first module of a final year project (FYP) developed under the supervision of Ma'am Fouzia.