Updated readme

This commit is contained in:
Kwoth
2021-07-18 00:00:01 +02:00
parent 711b2e1dde
commit 971b5078b7

View File

@@ -6,17 +6,19 @@
## Changes
- explain properly: Command attributes cleaned up
- explain properly: Database migrations cleaned up/squashed
- explain properly: coord and coord.yml
- wip: credentials.json moved to `creds.yml`, example is in `creds_example.yml`
- todo: from source run location is nadekobot/output
- todo: votes functionality changed
- todo: code cleanup tasks
- todo: remove colors from bot.cs
- todo: creds
- todo: from source installation (linux/windows) guide
- todo: docker installation guide
- Code cleanup
- Command attributes cleaned up
- Removed dummy Remarks and Usages attributes
- They were unused for a few patches but stayed in the code to avoid big git diffs
- All database migrations and data (json file) migrations have been removed
- As updating to the latest 2.x version before switching over to v3 is mandated (or fresh v3install), that means all migration code has ran and it can be safely removed
- There are 2 projects: NadekoBot and NadekoBot.Coordinator
- NadekoBot is the regular bot with one shard, or if you can run it if you want to run your shards
- credentials.json moved to `creds.yml`, example is in `creds_example.yml`, most of the credentials from 2.x will be automatically migrated
- Guide will now instruct users to set build output to nadekobot/output instead of running from nadekobot/src/NadekoBot/bin/release/net5
- todo: Reworked from source installation (linux/windows) guide <todo link>
- todo: Added docker installation guide at <todo link>
- todo?: votes functionality changed
- todo?: maybe use https://github.com/Humanizr/Humanizer for trimto, time printing, date printing, etc
- todo?: use guild locale more in the code (from guild settings) (for dates, currency, etc?)
- todo?: Write a sourcegen for response strings and use const/static fields (maybe even typed to enforce correct number of arguments)