Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Adrien35240 committed Dec 31, 2024
1 parent d45e786 commit 433bdb5
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 39 deletions.
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,38 @@
.github
# Welcome to the Atom Engine Organization! 🚀

Welcome to the official GitHub organization for **Atom Engine**, a lightweight and customizable 2D game engine built in C++. Whether you're here to follow the development, contribute, or just explore, we're glad to have you!

## About Atom Engine 🎮
Atom Engine is a passion project aimed at creating a **simple yet powerful 2D game engine** while deepening my understanding of C++. The engine is designed to be modular, easy to use, and perfect for indie game developers or anyone interested in game development.

### Key Features (Planned) ✨
- **2D Rendering**: Support for sprites, animations, and basic physics.
- **Cross-Platform**: Designed to work on multiple platforms (Windows, Linux, macOS).
- **Customizable**: Modular architecture to allow for easy extensions.
- **Documentation**: Comprehensive guides and API references to help you get started.

## Project Status 🚧
Atom Engine is currently in **active development**. While it’s not yet ready for public use, you can follow the progress and contribute ideas or feedback. Once it reaches a stable and feature-rich state, it will be released publicly for everyone to use and contribute to.

## How to Follow the Project 📅
- **GitHub Repositories**: Explore the code and track progress in the [Atom Engine repositories](https://github.com/AtomOrganization/AtomEngine).
- **Discord Community**: Join the live discussions, get updates, and connect with other developers on our [Discord server](https://discord.gg/j6qHgqWg5J).
- **Documentation**: Once available, the documentation will be hosted here to help you get started with the engine.

## Get Involved 🤝
Interested in contributing? Here’s how you can help:
- **Feedback**: Share your ideas, suggestions, or bug reports.
- **Code Contributions**: Once the project is public, feel free to submit pull requests.
- **Spread the Word**: Share the project with others who might be interested!

## Roadmap 🗺️
Here’s a high-level overview of what’s planned:
1. **Core Engine Development**: Building the foundational systems (rendering, input, physics).
2. **Documentation**: Writing guides and API references.
3. **Public Release**: Making the engine available for public use.
4. **Community Growth**: Encouraging contributions and building a community around Atom Engine.

## Stay Connected 🌐
Follow the journey of Atom Engine and stay updated with the latest developments:
- **GitHub**: [Atom Engine Organization](https://github.com/AtomOrganization/AtomEngine)
- **Discord**: [Join the Community](https://discord.gg/j6qHgqWg5J)
38 changes: 0 additions & 38 deletions profile/README.md

This file was deleted.

Binary file removed profile/logo.jpg
Binary file not shown.

0 comments on commit 433bdb5

Please sign in to comment.