Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
crazyRBLX11 authored Dec 7, 2024
1 parent 0e1e1ca commit 71e35c4
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Atom Framework
An easy to implement Roblox framework.
[![Lua](https://img.shields.io/badge/Lua-%232C2D72.svg?logo=lua&logoColor=white)](#) [![Markdown](https://img.shields.io/badge/Markdown-%23000000.svg?logo=markdown&logoColor=white)](#) [![YAML](https://img.shields.io/badge/YAML-CB171E?logo=yaml&logoColor=fff)](#)
<br /> An easy to implement Roblox framework.

## Introduction
The Atom Framework is an open-source framework used for crazyattaker1's games on Roblox.
Expand All @@ -15,4 +16,4 @@ Atom was designed to do all the heavy work for multi module codebases. Some of t
* Automatic Garbage Collection - Atom uses the Janitor module to clean up instances when they're no longer needed.

## Building Atom's source code
Do <b>NOT</b> build from this repository, due to limitations with putting scripts under ModuleScripts I've had to structure the repository entirely different than how Atom thinks it's structured. If you build this repository and try to use it nothing will work. If you know how I could fix this please put a pull request or an issue ticket and I'll contact you via it. If you'd like to use Atom, please use a pre-built .rbxm under releases.
Do <b>NOT</b> build from this repository, due to limitations with putting scripts under ModuleScripts I've had to structure the repository entirely different than how Atom thinks it's structured. If you build this repository and try to use it nothing will work. If you know how I could fix this please put a pull request or an issue ticket and I'll contact you via it. If you'd like to use Atom, please use a pre-built .rbxm under releases.

0 comments on commit 71e35c4

Please sign in to comment.