CanadianBacon/ModularDiscordBot
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
Connor Drahoss 2022-11-22 02:27:23 +00:00
parent 750c8e8882
commit 5b80fc165c
1 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,9 +1,27 @@
# Another Detailed Heuristical Discord (ADHD) Framework
>ADHD is a condition characterized by an ongoing pattern of inattention and/or hyperactivity-impulsivity that interferes with functioning or development.
ADHD is a framework on top of Discord.NET in order to allow others to write "efficient" (better than [discord.js](https://github.com/discordjs/discord.js/) and [discord.py](https://github.com/Rapptz/discord.py)) Discord bots while being able to learn C# at their own pace so they can be a much more useful human being.
# ADHD <sub>(Another Detailed Heuristical Discord)</sub> Framework
## ADHD aims to be a user-friendly, discord.py bot building like, Discord framework for .NET
[Jump to Documentation](#Documentation)
---
ADHD is licensed under the [MIT License](https://opensource.org/licenses/MIT).
## Why?
Most skids and "CS Students" (skids) tend to stick to languages like Python and Javascript for most things, including writing Discord bots.
This is mostly due to the barrier of entry for creating Discord bots in more generally useful languages like C# and Java as these require much more boilerplate and cyclomatic complexity.
## What?
**ADHD** is a framework that aims to reduce the barrier of entry for skids to **learn** more complex, general-purpose languages using a framework that they can directly interact with through a pre-made frontend, **DISCORD!**
For the time being ADHD will be little more than an easy to use, minimalist bot framework that aims to implement feature availability rather than full on ready-to-use features.
## How?
Through the ADHD bot framework, developers/scripters/etc will be able to write their own features for ADHD that can be dropped into the reference bot implementation of ADHD.
## AHSDASGA?!!!???!1
If you managed to have read the **How?** section in one go, congratulations, you most likely don't have ADHD, or you're amazing at hyperfocusing on programming related jargon and have severe ADHD.
---
## Documentation
To get started with ADHD, you can look at the [Getting Started Guide]() or look at these [Example Feature Implementations]() to see some real world examples.
Otherwise, if you're a smart cookie, you can look through the [API Documentation]()