modfetch/README.md

43 lines
783 B
Markdown
Raw Normal View History

2024-02-09 12:05:06 +01:00
# modfetch
modular fetch
each printable thing is a separate module in a shared object
modfetch loads and calls them at runtime to print system info
2024-02-09 12:05:06 +01:00
## building
`make` for the main binary
`make modules` for all the default modules
write your own using `mod.h` if you want to
## config
2024-02-09 21:38:05 +01:00
by default `$XDG_CONFIG_HOME/modfetch.conf`
2024-02-09 12:05:06 +01:00
format:
```
/path/to/mod1.so
/path/to/mod2.so {
var1 = dupa
var2 = 2137
}
```
## TODO
2024-02-09 22:14:57 +01:00
- [ ] module api versioning
2024-02-09 12:06:17 +01:00
- [ ] module manager (url to module source, compiles and puts the binary somewhere)
- [ ] better config parsing
- [ ] more text positioning options aside from printing text vertically
2024-02-09 12:09:30 +01:00
- [ ] some way for module to throw errors
2024-02-09 12:19:46 +01:00
- [ ] module related options (list module, print specific module info, etc.)
2024-02-09 12:05:06 +01:00
## license
mit