generated from lucxjo/template
Updated README and CONTRIBUTING to have
correct repository info Signed-off-by: Louis Hollingworth <louis@hollingworth.ch>
This commit is contained in:
parent
429504787a
commit
b62ab78325
|
@ -1,11 +1,11 @@
|
||||||
# How to contribute
|
# How to contribute
|
||||||
|
|
||||||
<!-- TODO: Change <PROJECT_NAME> -->
|
<!-- TODO: Change <PROJECT_NAME> -->
|
||||||
Contributions to <PROJECT_NAME> are highly encouraged and desired. Below are some guidelines that will help make the process as smooth as possible.
|
Contributions to ER are highly encouraged and desired. Below are some guidelines that will help make the process as smooth as possible.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
- Make sure you have a [GitHub account](https://github.com/signup/free)
|
- Make sure you have a [Ludo Git account](https://git.ludoviko.ch/user/sign_up)
|
||||||
- Submit a new issue, assuming one does not already exist.
|
- Submit a new issue, assuming one does not already exist.
|
||||||
- Clearly describe the issue including steps to reproduce when it is a bug.
|
- Clearly describe the issue including steps to reproduce when it is a bug.
|
||||||
- Make sure you fill in the earliest version that you know has the issue.
|
- Make sure you fill in the earliest version that you know has the issue.
|
||||||
|
|
18
README.md
18
README.md
|
@ -1,2 +1,16 @@
|
||||||
# template
|
# ER - Edvin Rydburg
|
||||||
A general template repo
|
A Discord bot designed around the [Young Royals](https://discord.gg/youngroyals)
|
||||||
|
Discord guild. This bot is the first generation of what will become Klara.
|
||||||
|
|
||||||
|
The intent for this bot is as a playground for features of the future Klara bot
|
||||||
|
that will be written in Rust or Go.
|
||||||
|
|
||||||
|
## Why TS/JS then Rust or Go?
|
||||||
|
Discordx makes it extremely easy to build a bot, so while I'm figuring things
|
||||||
|
out, this will ensure that I can quickly realise what will be needed. Once what
|
||||||
|
is needed is known, a more stable version can be made that, in Rust or Go, will
|
||||||
|
consume far less resources.
|
||||||
|
|
||||||
|
## Will the future Klara still be open-source?
|
||||||
|
Yes! Of course! Practically everything I do is open-source, I don't believe that
|
||||||
|
hiding work particularly helps anyone.
|
||||||
|
|
Loading…
Reference in a new issue