From 810cb8655fc97ce19db5f9190cb390f655d0f0d2 Mon Sep 17 00:00:00 2001
From: xAlpharax <42233094+xAlpharax@users.noreply.github.com>
Date: Mon, 14 Aug 2023 20:40:34 +0300
Subject: Initial fork from https://git.suckless.org/slstatus

Changes to be committed:
    new file:   LICENSE
    new file:   Makefile
    new file:   README
    new file:   arg.h
    new file:   components/battery.c
    new file:   components/cat.c
    new file:   components/cpu.c
    new file:   components/datetime.c
    new file:   components/disk.c
    new file:   components/entropy.c
    new file:   components/hostname.c
    new file:   components/ip.c
    new file:   components/kernel_release.c
    new file:   components/keyboard_indicators.c
    new file:   components/keymap.c
    new file:   components/load_avg.c
    new file:   components/netspeeds.c
    new file:   components/num_files.c
    new file:   components/ram.c
    new file:   components/run_command.c
    new file:   components/swap.c
    new file:   components/temperature.c
    new file:   components/uptime.c
    new file:   components/user.c
    new file:   components/volume.c
    new file:   components/wifi.c
    new file:   config.def.h
    new file:   config.mk
    new file:   slstatus.1
    new file:   slstatus.c
    new file:   slstatus.h
    new file:   util.c
    new file:   util.h
---
 README | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 README

(limited to 'README')

diff --git a/README b/README
new file mode 100644
index 0000000..12d38bf
--- /dev/null
+++ b/README
@@ -0,0 +1,65 @@
+slstatus - suckless status
+==========================
+slstatus is a small tool for providing system status information to other
+programs over the EWMH property of the root window (used by dwm(1)) or
+standard input/output. It is designed to be as efficient as possible by
+only issuing the minimum of system calls required.
+
+
+Features
+--------
+- Battery percentage/state/time left
+- Cat (read file)
+- CPU usage
+- CPU frequency
+- Custom shell commands
+- Date and time
+- Disk status (free storage, percentage, total storage and used storage)
+- Available entropy
+- Username/GID/UID
+- Hostname
+- IP address (IPv4 and IPv6)
+- Kernel version
+- Keyboard indicators
+- Keymap
+- Load average
+- Network speeds (RX and TX)
+- Number of files in a directory (hint: Maildir)
+- Memory status (free memory, percentage, total memory and used memory)
+- Swap status (free swap, percentage, total swap and used swap)
+- Temperature
+- Uptime
+- Volume percentage
+- WiFi signal percentage and ESSID
+
+
+Requirements
+------------
+Currently slstatus works on FreeBSD, Linux and OpenBSD.
+In order to build slstatus you need the Xlib header files.
+
+- For volume percentage on Linux the kernel module `snd-mixer-oss` must be
+  loaded.
+- For volume percentage on FreeBSD, `sndio` must be installed.
+
+
+Installation
+------------
+Edit config.mk to match your local setup (slstatus is installed into the
+/usr/local namespace by default).
+
+Afterwards enter the following command to build and install slstatus (if
+necessary as root):
+
+    make clean install
+
+
+Running slstatus
+----------------
+See the man page for details.
+
+
+Configuration
+-------------
+slstatus can be customized by creating a custom config.h and (re)compiling the
+source code. This keeps it fast, secure and simple.
-- 
cgit v1.2.3