aboutsummaryrefslogtreecommitdiff
path: root/fetcha/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'fetcha/README.md')
-rw-r--r--fetcha/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/fetcha/README.md b/fetcha/README.md
new file mode 100644
index 0000000..9ce2276
--- /dev/null
+++ b/fetcha/README.md
@@ -0,0 +1,27 @@
+# fetcha - suckless-like system info fetch
+fetcha is an fast, small and easy configurated system info fetch.
+
+![fetcha image](docs/img/fetcha.jpg)
+## Requirements
+To insatll fetcha you need `git`.
+## Installation
+1. clone the repository.
+```
+git clone https://github.com/Cryobs/fetcha
+```
+2. go to `fetcha` directory
+```
+cd fetcha
+```
+3. build fetcha (if necessary as root)
+```
+make clean install
+```
+## Running fetcha
+```
+fetcha
+```
+If you want fetcha to open together with your terminal, add the line `fetcha` to the end of `~/<your-shell>rc` (for example `.bashrc`, `.zshrc`).
+## Configuration
+The configuration is similar to suckless-type programs, i.e., copy the `config.def.h` file to `config.h`, and after customizing `config.h`, you need to recompile the source code.
+(How to configure see the man pages ( fetcha-config(5) ))