Docs/Deploy_Guide.md

# 1. Hugging Face
---

## How to Update `README.md` on Hugging Face Repo

### Step 1: Edit `README.md` locally

Open your project folder and edit the `README.md` file using any text editor or IDE.

Example, you can add:

```markdown
# Edu MentorAI

This project is an AI-powered educational mentor bot.

## Features

- AI-based question answering
- Interactive learning
- Supports multiple subjects

## How to use

1. Clone the repo
2. Run the app
3. Interact with the mentor AI
```

Save the changes.

---

### Step 2: Stage the changes

```bash
git add README.md
```

---

### Step 3: Commit the changes

```bash
git commit -m "Update README.md with project details"
```

---

### Step 4: Push to Hugging Face remote

```bash
git push hf main
```

---

### If you haven't set upstream yet, use

```bash
git push --set-upstream hf main
```

---

## Bonus: Preview README on Hugging Face Hub

After pushing, go to your repo page on Hugging Face (e.g., [https://huggingface.co/spaces/selvaneyas/Edu-MentorAI](https://huggingface.co/spaces/selvaneyas/Edu-MentorAI)), and you'll see the rendered README.

---

# 2. GitHub
---

## ✅ Steps to Update `README.md` on GitHub

### Step 1: Open and edit `README.md`

Update your content in any editor. For example:

````markdown
# Edu MentorAI 🚀

An AI-powered virtual educational assistant to help students learn faster and smarter.

## ✨ Features

- 📚 Smart learning suggestions
- 💬 Natural language Q&A
- 🧠 AI-based explanations

## 🛠️ How to Run

```bash
git clone https://github.com/selvaneyas/Edu-MentorAI.git
cd Edu-MentorAI
streamlit run app.py
```

## 🙌 Contributing

Pull requests are welcome!

## 📄 License

MIT

````

Save the file.

---

### Step 2: Stage the file

```bash
git add README.md
````

---

### Step 3: Commit the changes

````bash
git commit -m "Update README.md with project description and usage"
````

---

### Step 4: Push to **GitHub** remote (`origin`)

If you already have GitHub as `origin`:

````bash
git push origin main
````

Or, if your GitHub branch is not set up:

````bash
git push --set-upstream origin main
````

---

### ✅ Confirm

Visit your GitHub repo at:

````
https://github.com/selvaneyas/Edu-MentorAI
````

You’ll see the rendered `README.md` at the bottom of the page.


---