Skip to content

Commit 2dc23ed

Browse files
authored
Merge pull request #1095 from DivyaJain-DataAnalyst/main
Documentation: Updated Readme.md file for GSSoC'25 compliance
2 parents 4c6c64d + 3fffe39 commit 2dc23ed

2 files changed

Lines changed: 136 additions & 1 deletion

File tree

README.md

Lines changed: 136 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<div align="center">
2+
23
<!-- <table align="center">
34
<thead align="center">
45
<tr border: 2px;>
@@ -24,6 +25,14 @@
2425

2526
<!-- <h1 align="center"><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/Cyclone.png" alt="Cyclone" width="25" height="25" /> Paradise For Developers <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/Cyclone.png" alt="Cyclone" width="25" height="25" /></h1> -->
2627

28+
# 🔐 Dev-Display
29+
30+
![GSSoC Logo]([https://github.com/DivyaJain-DataAnalyst/DevDisplay/blob/main/public/gssoc%20logo.png](https://github.com/DivyaJain-DataAnalyst/DevDisplay/blob/main/public/gssoc%20logo.png))
31+
32+
🌐 Visit the website to explore real-world projects, filter by tech stack, and discover new ideas!
33+
34+
---
35+
2736
<a href="https://www.devdisplay.org/"><img src="./public/assets/DevDisplayLOGO/NameTagline.png" width="300px" /></a><br>
2837
<a href="https://www.devdisplay.org/"><img src="./public/DDColorLOGO.png" width="500px" /></a><br>
2938

@@ -55,6 +64,18 @@
5564
5665
</div>
5766
</details> -->
67+
68+
<p align="center">
69+
<strong>An open-source framework to build and deploy intelligent, self-hosted AI agents that can handle real-world phone calls.</strong>
70+
<br />
71+
<br />
72+
<!-- <a href="#-getting-started-in-under-5-minutes"><strong>🚀 Get Started</strong></a> -->
73+
·
74+
<a href="https://github.com/codeaashu/DevDisplay/issues"><strong>🐛 Report a Bug</strong></a>
75+
·
76+
<a href="https://github.com/codeaashu/DevDisplay/issues"><strong>✨ Request a Feature</strong></a>
77+
</p>
78+
5879
<img align="center" src="./public/star.png" width="150px" />
5980
</div>
6081

@@ -185,7 +206,58 @@
185206
<h2 align="center"><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Telegram-Animated-Emojis/main/Activity/Sparkles.webp" alt="Sparkles" width="25" height="25" />How to Earn These Badges?<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Telegram-Animated-Emojis/main/Activity/Sparkles.webp" alt="Sparkles" width="25" height="25" /><br><br><a href="https://github.com/codeaashu/DevDisplay/blob/main/contribution/ContributionBadges.md#-devdisplay-contributor-badges-"><img src="https://img.shields.io/badge/Click%20Here%20For%20Details-000000?style=for-the-badge&logo=github&logoColor=white" alt="How to Earn These Badges">
186207
</a></h2>
187208

188-
<div align="center"><img align="center" src="./public/star.png" width="150px" /></div>
209+
<div align="center"><img align="center" src="./public/star.png" width="150px" />
210+
</div>
211+
212+
## 📥 Submitting a Pull Request
213+
214+
Follow these steps to contribute your changes to **DevDisplay**:
215+
216+
1. **🌟 Star & Fork the Repository**
217+
Click the **“Star”** button to support the project, then **“Fork”** the repo to create your own copy:
218+
👉 [https://github.com/codeaashu/DevDisplay](https://github.com/codeaashu/DevDisplay)
219+
220+
2. **📥 Clone Your Fork**
221+
Use the following command to clone your forked repository to your local machine:
222+
```bash
223+
git clone https://github.com/Your-Username/DevDisplay.git
224+
```
225+
3. Create a Branch
226+
Navigate to the project directory and create a new branch for your changes:
227+
228+
```bash
229+
cd DevDisplay
230+
git checkout -b my-feature-branch
231+
```
232+
233+
4. Make Changes
234+
Add your new ML projects, games, websites, or enhancements. Fix bugs or improve UI/UX as needed.
235+
236+
5. Commit Your Changes
237+
Use a meaningful commit message:
238+
239+
```bash
240+
git add .
241+
git commit -m "📦 [Feature Add] Add XYZ website project"
242+
```
243+
244+
6. Push Your Changes
245+
Push your branch to your GitHub fork:
246+
247+
```bash
248+
git push origin my-feature-branch
249+
```
250+
7. Submit a Pull Request
251+
252+
Go to your fork on GitHub.
253+
254+
Click "Compare & pull request".
255+
256+
Add a descriptive title using one of the prefixes: [UI], [UX], [Feature Add].
257+
258+
Link the related issue (if any) and clearly describe your changes.
259+
260+
---
189261

190262
<h1 align="center">Featured in <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/Star.png" alt="Star" width="25" height="25" /></h1>
191263
<table>
@@ -275,3 +347,66 @@ This project is licensed under <a href="./LICENSE">MIT</a>. <img width=2300/>
275347
</a><br>
276348
<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Mirror%20Ball.png" alt="Mirror Ball" width="150" height="150" />
277349
</div>
350+
351+
📂 Explore the Project Directory Structure
352+
353+
```bash
354+
355+
DevDisplay/
356+
├── public/ # Static assets
357+
│ ├── assets/
358+
│ │ ├── SocialLogo/ # Social media logos (GitHub.png, Discord.png, etc.)
359+
│ │ ├── SupportedBy/ # Partner logos (MicrosoftForStartups.png, etc.)
360+
│ │ ├── DevBadges/ # Contributor badges (DevPioneerpng.gif, etc.)
361+
│ │ └── DevDisplayLOGO/ # Main logos (NameTagline.png)
362+
│ ├── gssoc logo.png # GSSoC logo
363+
│ ├── DDColorLOGO.png # Main logo
364+
│ └── star.png # Decorative image
365+
├── src/ # Source code
366+
│ ├── styles/ # CSS/Stylesheets
367+
│ └── scripts/ # JavaScript files
368+
├── .gitignore # Files to ignore in Git
369+
├── .prettierrc.json # Prettier configuration
370+
├── CODE_OF_CONDUCT.md # Community guidelines
371+
├── CONTRIBUTING.md # Contribution guidelines
372+
├── LICENSE # MIT License
373+
├── package.json # Project dependencies
374+
├── package-lock.json # Lock file for dependencies
375+
├── README.md # Project documentation
376+
├── SECURITY.md # Security policy
377+
├── tailwind.config.js # Tailwind CSS configuration
378+
└── generate-sitemap.js # Sitemap generator script
379+
```
380+
381+
---
382+
383+
## 🙌 Contributors
384+
385+
Thanks to these amazing people who have contributed to the **Dev-Display** project:
386+
387+
<!-- readme: contributors -start -->
388+
<p align="center">
389+
<img src="https://api.vaunt.dev/v1/github/entities/codeaashu/repositories/DevDisplay/contributors?format=svg&limit=54" width="1000" />
390+
</p>
391+
<!-- readme: contributors -end -->
392+
393+
---
394+
395+
## 💡 Suggestions & Feedback
396+
Feel free to open issues or discussions if you have any feedback, feature suggestions, or want to collaborate!
397+
398+
---
399+
400+
## 📜 Code of Conduct
401+
402+
To ensure a welcoming and inclusive environment, we have a Code of Conduct that all contributors are expected to follow. In short: **Be respectful, be kind, and be collaborative.** Please read the full [Code of Conduct](https://github.com/codeaashu/DevDisplay/blob/main/CODE_OF_CONDUCT.md) before participating.
403+
404+
---
405+
406+
## 📄 License
407+
408+
This project is licensed under the [MIT License](https://github.com/codeaashu/DevDisplay/blob/main/LICENSE).
409+
410+
---
411+
412+
Thank you again for your interest. We can't wait to see what you build with us! ❤️❤️

public/gssoc logo.png

129 KB
Loading

0 commit comments

Comments
 (0)