Hugging Face's logo

Spaces:
selvaneyas
/
Edu-MentorAI
Running

App Files Community
Edu-MentorAI
File size: 2,297 Bytes 
5038c1e
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# 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.


---