modfetch/README.md

45 lines
888 B
Markdown
Raw Permalink 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
2024-02-11 18:35:41 +01:00
`make` to build everything
`make modfetch` for the main binary
2024-02-09 12:05:06 +01:00
`make modules` for all the default modules
write your own using `mod.h` if you want to
## config
by default `$XDG_CONFIG_HOME/modfetch.conf`, `~/.config/modfetch.conf` if `$XDG_CONFIG_HOME` doesn't exist
2024-02-09 12:05:06 +01:00
format:
```
/path/to/mod1.so
/path/to/mod2.so {
var1 = dupa
var2 = 2137
}
```
## TODO
2024-02-11 19:42:39 +01:00
- [x] ~~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-12 14:15:28 +01:00
- [ ] some way for modules 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