Skip to content

Commit

Permalink
Readme added for multiple folders
Browse files Browse the repository at this point in the history
  • Loading branch information
awaissaddiqui committed Oct 17, 2024
1 parent 5b48c50 commit 204024f
Show file tree
Hide file tree
Showing 8 changed files with 178 additions and 0 deletions.
20 changes: 20 additions & 0 deletions C++/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# C++ Projects

Welcome to the **C++ Projects** section of the Hacktoberfest 2024 repository! 🚀

## Project Overview

This folder contains various C++ projects contributed by developers from all over the world. Each project focuses on different data structures, algorithms, and concepts in C++.

### Current Projects:
- **FIFO**: First In, First Out implementation.
- More to come...

## How to Contribute

1. **Fork** the repository.
2. Clone your fork: `git clone https://github.com/your-username/hacktoberfest-24.git`.
3. Add new C++ projects under this folder.
4. Submit a PR with your changes.

Contributions are welcome! Check out the [CONTRIBUTING.md](../CONTRIBUTING.md) for guidelines.
41 changes: 41 additions & 0 deletions Docs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Documentation and Non-Coding Contributions

Welcome to the **Docs** section of the Hacktoberfest 2024 repository! 📝

## Overview

This folder is dedicated to **non-coding contributions**, including design documents, tutorials, research papers, brainstorming ideas, and any other helpful resources for contributors. It's a space for those who want to contribute to the project without writing code but still play a vital role in its success.

### What to Add Here

- **Project Documentation**: Add or update documentation that explains various aspects of the project.
- **Tutorials**: Create and share tutorials on using the project or its components.
- **Design Proposals**: Contribute design ideas or workflows that can improve the user experience or project structure.
- **Research Papers & Articles**: Share articles, papers, or links to important resources relevant to the technologies used in the repository.
- **Other Resources**: Add any other non-coding items that can benefit contributors or users, such as diagrams, flowcharts, or FAQs.

### How to Contribute

1. **Fork** the repository.
2. Clone your fork: `git clone https://github.com/your-username/hacktoberfest-24.git`.
3. Add your non-coding contributions under this folder.
4. Submit a PR with your changes.

### Guidelines

- Ensure that the documentation is **clear** and **concise**.
- Provide appropriate **references** or **citations** for any external resources.
- Organize the content with appropriate file names and structure.
- Keep your contributions **relevant** to the project.

## Contribution Examples

- **Tutorial**: "How to Set Up the Development Environment"
- **Design Proposal**: UI/UX improvements for a specific project
- **Research Paper**: A paper explaining an algorithm used in the project

For more details on contributing, refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file.

---

Make your mark on Hacktoberfest 2024 with meaningful non-code contributions!
20 changes: 20 additions & 0 deletions Flutter/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Flutter Projects

Welcome to the **Flutter Projects** section of the Hacktoberfest 2024 repository! 🌟

## Project Overview

This folder is dedicated to **Flutter** projects that range from UI designs to full-fledged applications.

### Current Projects:
- **Docs**: Explore Flutter's documentation and how it integrates with Hacktoberfest.
- More to come...

## How to Contribute

1. **Fork** the repository.
2. Clone your fork: `git clone https://github.com/your-username/hacktoberfest-24.git`.
3. Add new Flutter projects or widgets under this folder.
4. Submit a PR with your changes.

Join the community of Flutter developers and help make open-source better! Review [CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
21 changes: 21 additions & 0 deletions Java/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Java Projects

Welcome to the **Java Projects** section of the Hacktoberfest 2024 repository! ☕️

## Project Overview

This folder contains Java-based projects focusing on sorting algorithms, data structures, and more.

### Current Projects:
- **CountingSort.java**: An implementation of the Counting Sort algorithm.
- **MergeSort.java**: Implementation of Merge Sort.
- More to come...

## How to Contribute

1. **Fork** the repository.
2. Clone your fork: `git clone https://github.com/your-username/hacktoberfest-24.git`.
3. Add new Java projects or algorithms under this folder.
4. Submit a PR with your changes.

Get started with open-source Java contributions today! For guidelines, check [CONTRIBUTING.md](../CONTRIBUTING.md).
19 changes: 19 additions & 0 deletions JavaScript-Projects/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# JavaScript Projects

Welcome to the **JavaScript Projects** section of the Hacktoberfest 2024 repository! 🖥️

## Project Overview

This folder hosts exciting **JavaScript** projects from web development to algorithms and everything in between.

### Current Projects:
- Coming soon...

## How to Contribute

1. **Fork** the repository.
2. Clone your fork: `git clone https://github.com/your-username/hacktoberfest-24.git`.
3. Add your JavaScript-based projects or web apps here.
4. Submit a PR with your changes.

Dive into the world of JavaScript! Review [CONTRIBUTING.md](../CONTRIBUTING.md) before contributing.
19 changes: 19 additions & 0 deletions Machine-Learning/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Machine Learning Projects

Welcome to the **Machine Learning** section of the Hacktoberfest 2024 repository! 🤖

## Project Overview

This folder contains projects that apply machine learning models and techniques.

### Current Projects:
- Coming soon...

## How to Contribute

1. **Fork** the repository.
2. Clone your fork: `git clone https://github.com/your-username/hacktoberfest-24.git`.
3. Add new ML models, datasets, or notebooks under this folder.
4. Submit a PR with your changes.

Start contributing to open-source machine learning projects today! Refer to [CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
19 changes: 19 additions & 0 deletions Others/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Other Projects

Welcome to the **Others** section of the Hacktoberfest 2024 repository! 🌐

## Project Overview

This folder is a collection of various miscellaneous projects that don't fit into other specific categories.

### Current Projects:
- Coming soon...

## How to Contribute

1. **Fork** the repository.
2. Clone your fork: `git clone https://github.com/your-username/hacktoberfest-24.git`.
3. Add unique projects or contributions under this folder.
4. Submit a PR with your changes.

Let's make Hacktoberfest more diverse with your creative ideas! Check out [CONTRIBUTING.md](../CONTRIBUTING.md) for more.
19 changes: 19 additions & 0 deletions Python/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Python Projects

Welcome to the **Python Projects** section of the Hacktoberfest 2024 repository! 🐍

## Project Overview

This folder contains Python scripts, projects, and algorithms contributed by the community.

### Current Projects:
- Coming soon...

## How to Contribute

1. **Fork** the repository.
2. Clone your fork: `git clone https://github.com/your-username/hacktoberfest-24.git`.
3. Add Python-based projects or scripts under this folder.
4. Submit a PR with your changes.

Help grow the Python ecosystem by contributing! Make sure to review [CONTRIBUTING.md](../CONTRIBUTING.md) before starting.

0 comments on commit 204024f

Please sign in to comment.