README.md 1.86 KB
Newer Older
Admin's avatar
Admin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
HomeBot Deployment (Installation) and first steps

# What is it?

HomeBot is a fork of FHEM (http://www.fhem.de/) and there is no own page, forum
or wiki except the GitLab repository https://gl.petatech.eu/root/HomeBot

This project is neither an "official" fork, nor endorsed and especially not
supported by any of the FHEM authors. Please do not pester anyone at the
FHEM project with support questions if you have problems with HomeBot.
You can/should open a ticket in the HomeBot GitLab.

HomeBot tries to be a more progressive version of FHEM. This means especially
modernizing the codebase. In order to do that - and because HomeBot does not
need to maintain the legacy of FHEM - support for older Perls and all OSes
except Linux is dropped. HomeBot will aspire to support all Unixoid OSes up
to maybe even MacOS again - sometime in the future. Maybe.

If you can't run HomeBot on a Linux box with a fairly modern Perl (5.28.1+),
HomeBot is not for you. If you are not sort of a developer yourself, HomeBot
is - at least for the moment - not for you.

# How do I install it?

See INSTALL.md

At the moment it is expected you fetch the sources via

    git clone https://gl.petatech.eu/root/HomeBot.git
    
and then simply do

    make install

in the HomeBot directory (where the Makefile is). It is **highly** recommended
that you install [Perlbrew](https://perlbrew.pl/) first and use that Perl
(remember: 5.28.1+) as your HomeBot environment. This way, you decouple your
HomeBot infrastructure from the OS Perl installation.

Once you have established that, your update cycle should become very easy:

42
    make update
Admin's avatar
Admin committed
43
44
45
46
47
48
49

# Can I contribute?

Well - sure. If you are willing to code according to most PBP (Perl Best
Practices) and modern Perl standards, writing Testsuites, maybe even TDD.
If you want to deliver the best code possible and aren't afraid of Perl::Critic
and Human::Critic. ;-)