Updated README to match refactoring

This commit is contained in:
Joshua Boniface 2017-03-31 02:08:35 -04:00
parent 7918441182
commit c6e5431d47
1 changed files with 14 additions and 1 deletions

View File

@ -1,2 +1,15 @@
# rpibmc
A BMC (LOM) created with a Raspberry Pi
A BMC (LOM) created with a Raspberry Pi.
Allows one to build a Raspberry Pi-based BMC unit for an IPMI-less server.
There are three main files:
1) `bmcd` - BMC Daemon
Runs in the background of the system and handles reading and writing GPIO.
2) `bmc.sh` - The BMC shell
Should be set as the default shell of the login user (`bmc`) and provides
user interface to the BMC.
3) `rc.local` - The rc.local file
The system `rc.local` should be replaced (or symlinked) to this file to start
the `bmcd` daemon and `screen` console session on boot.