[docs] some more updates

This commit is contained in:
tobi-wan-kenobi 2020-05-05 19:55:19 +02:00
parent 0b7f61b62e
commit 0b0780b213
7 changed files with 54 additions and 54 deletions

View file

@ -6,6 +6,43 @@
Welcome to bumblebee-status's documentation!
============================================
bumblebee-status is a modular, theme-able status line generator for the
`i3 window manager <https://i3wm.org/>`__.
Focus is on:
- ease of use, sane defaults (no mandatory configuration file)
- custom modules: :doc:`development/module`
- custom themes: :doc:`development/theme`
I hope you like it and I appreciate any kind of feedback: bug reports,
feature requests, etc. :)
Thanks a lot!
+------------------------------------+-------------------------+
| **Required i3wm version** | 4.12+ |
+------------------------------------+-------------------------+
| **Supported Python versions** | 3.4, 3.5, 3.6, 3.7, 3.8 |
+------------------------------------+-------------------------+
| **Supported FontAwesome versions** | 4 only |
+------------------------------------+-------------------------+
| **Per-module requirements** | see :doc:`modules` |
+------------------------------------+-------------------------+
see :doc:`FAQ` for details on this
Example usage:
.. code-block::
bar {
status_command <path>/bumblebee-status \
-m cpu memory battery time pasink pasource \
-p time.format="%H:%M" \
-t solarized
}
.. toctree::
:maxdepth: 2
:caption: Contents
@ -17,7 +54,7 @@ Welcome to bumblebee-status's documentation!
themes
development/index
src/modules
api
Indices and tables
==================