i accidentally put the readme in src/ lmao

This commit is contained in:
askiiart 2024-12-26 12:25:25 -06:00
parent bd880f4f5f
commit cd2db61e34
Signed by untrusted user who does not match committer: askiiart
GPG key ID: EA85979611654C30

19
README.md Normal file
View file

@ -0,0 +1,19 @@
# Gregory
This is Gregory. Gregory controls repos. Gregory keeps track of updating repos, trying to be simple and elegant, but enough.
## TODO
- Add sources (similar to `sources` in a PKGBUILD)?
- Add support for loading scripts rather than listing commands
- Add multithreading
- Add better/custom grouping for when to run jobs (dependency system?)
- Add dependency system (automatic detection?)
- Add hook system
## Other stuff
- The formatting for the config file (`gregory.yml`) was heavily inspired by Drone's config.
- Why the name?
- I was thinking to go with something dark and foreboding, since this is a program to control *everything* about a repo - it's the high command. But I couldn't think of anything and thought just naming it some lame random name instead would be way funnier. Hence, Gregory.
- Gregory is a program, so it uses it/its pronouns. It also doesn't mind whether you capitalize its name or not, "gregory" or "Gregory" are fine, you can even shorten it if you want.