Skip to content

Commit e177e65

Browse files
committed
hopefully improbe start script documentation
1 parent f6dac90 commit e177e65

1 file changed

Lines changed: 26 additions & 7 deletions

File tree

scripts/start.sh

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,16 +82,35 @@ cat <<EOF
8282
8383
8484
Your bot(s) should now be connected to the configured Mumble server.
85-
Have fun with mumble-ruby-pluginbot :)
8685
87-
If something doesn't work, start this script with the additional parameter debug:
88-
~/src/mumble-ruby-pluginbot/scripts/start.sh debug
8986
90-
Then take a look into the logfile within $HOME/logs/.
87+
_LOGGING/DEBUGGING_
88+
If something doesn't work, start this script with the additional parameter debug:
89+
~/src/mumble-ruby-pluginbot/scripts/start.sh debug
9190
92-
Also make sure to run this script as user botmaster if you used the official installation documentation and DO NOT RUN THIS SCRIPT AS root.
91+
Then take a look into the logfile within $HOME/logs/.
9392
94-
If you want to update the pluginbot please run ~/src/mumble-ruby-pluginbot/scripts/updater.sh
9593
96-
Also please reread the official documentation at https://wiki.natenom.com/w/Mumble-Ruby-Pluginbot
94+
_START AS APPROPRIATE USER_
95+
Make sure to run this script as user botmaster if you used the official
96+
installation documentation and DO NOT RUN THIS SCRIPT AS root.
97+
The official documentation can be found at https://wiki.natenom.com/w/Mumble-Ruby-Pluginbot
98+
99+
100+
_UPDATE THE BOT (AND ITS DEPENDENCIES)_
101+
If you want to update the Mumble-Ruby-Pluginbot (and its dependencies) please
102+
run ~/src/mumble-ruby-pluginbot/scripts/updater.sh
103+
104+
105+
_OFFICIAL DOCUMENTATION_
106+
Also please reread the official documentation at https://wiki.natenom.com/w/Mumble-Ruby-Pluginbot
107+
if you have further problems :)
108+
109+
110+
_BUGS/WISHES/IDEAS_
111+
If you think you found a bug, have a wish for the bot or some ideas please don't
112+
hesitate to create an issue at https://github.com/dafoxia/mumble-ruby-pluginbot/issues
113+
114+
115+
Have fun with the Mumble-Ruby-Pluginbot :)
97116
EOF

0 commit comments

Comments
 (0)