summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2021-05-28 13:09:25 +0200
committerxengineering <mail2xengineering@protonmail.com>2021-05-28 13:09:25 +0200
commitbf399a0b507ac06ac2fac64558d581dbcc056526 (patch)
treec30024b9141bb324b05d0b5e6bc3b82658a03c71
parent865035fe736214060a9362f5996439185332e093 (diff)
downloadxbot-bf399a0b507ac06ac2fac64558d581dbcc056526.tar
xbot-bf399a0b507ac06ac2fac64558d581dbcc056526.tar.zst
xbot-bf399a0b507ac06ac2fac64558d581dbcc056526.zip
Documentation of example Profile0.1.0
-rw-r--r--Makefile3
-rw-r--r--example_profile.ini11
2 files changed, 13 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index ff0e394..d6906b0 100644
--- a/Makefile
+++ b/Makefile
@@ -29,7 +29,8 @@ install: all
uninstall:
sudo rm -f $(bindir)/xbot
-.PHONY: clean uninstall
clean:
rm -r build
+.PHONY: all install uninstall clean
+
diff --git a/example_profile.ini b/example_profile.ini
index d6ba4f2..30f7a09 100644
--- a/example_profile.ini
+++ b/example_profile.ini
@@ -1,3 +1,14 @@
+; This is an example configuration file for the xbot software.
+; URL: https://src.xengineering.eu/xengineering/xbot/src/branch/master
+
+; Usage: Simply copy this file to a new location and edit the fields
+; below. You can then reference this profile like this:
+; $ xbot -m "Example message" -j "recipient@example.com" -p /path/to/my/profile.ini
+; or copy it to the default location ~/.config/xbot/profile.ini and use xbot like this:
+; $ xbot -m "Example message" -j "recipient@example.com"
+
+
[xbot]
my_jabber_id=user@example.com
password=password123&%
+