Include default scripts about i3blocks-contrib HOT 6 CLOSED

I am happy to do this. I will probably get it done this weekend.

I will keep the names of all the default blocklets as they appear in the main repo now. I will rename conflicting named blocklets in the contrib repo. For config files, what naming convention would you like? Just config or i3blocks.conf or something else? I will also read your other issue more carefully soon.

As a side note, some of the blocklets require compilation (bandwidth2 comes to mind, I will have to check if any others do) so just keep that in mind in case a package maintainer needs to coordinate.

Also, some blocklets require outside dependencies, another fact that requires no specific action at the moment but is relevant for maintainers to keep in mind.

from i3blocks-contrib.

Thanks @kb100. Let's hold on this until we figure out what is the best thing to do for default scripts in #121.

from i3blocks-contrib.

I think we are good to go. What I'll do next is providing an helpful message directly in the status bar if there is no config file found or no blocklet, so that running i3blocks the first time won't feel like an error to the users.

For config files, what naming convention would you like? Just config or i3blocks.conf or something else?

I think we must use something which avoids any conflict with the user configuration and updates (e.g. git pull). The simplest step I can think of after installing i3blocks for a lazy user is:

$ git clone [email protected]:vivien/i3blocks-contrib.git ~/.config/i3blocks
$ cd ~/.config/i3blocks
$ cp config.example config
$ i3-msg restart

So I'd suggest a suffixed name like config.example to encourage users to copy it and avoid conflicts in the future. What do you think?

from i3blocks-contrib.

I think a config.example or perhaps even a few example configs minimal_config.example, etc. could be used. What about the configs provided in each blocklet directory though? Same convention with config.example?

from i3blocks-contrib.

Indeed we can imagine per-distro config files like debian.config.example using the apt-upgrade blocklet, etc. For the config files provided in each blocklet, there are unfortunately here just for documentation purpose, so I think keeping config is fine, that is up to you ;-)

from i3blocks-contrib.

All default scripts included.

from i3blocks-contrib.