Documentation #88
Documentation #88
Conversation
|
This will be the "last planed" addition for 0.7 but I'm going to need a bit more time to review it properly. ⏳ |
docs/mosquitto.md
Outdated
| @@ -0,0 +1,27 @@ | |||
| ## Description | |||
| **This script was broken since packages are not available for Debian Stretch, but we have implemented an workaround that make sure this will run as intended on HASSbian Stretch.** | |||
There was a problem hiding this comment.
This is a tad out of date now ;)
There was a problem hiding this comment.
I was not when I first made this :) corrected now
docs/webterminal.md
Outdated
| @@ -0,0 +1,31 @@ | |||
| ## Description | |||
| This script installs an web terminal called 'shellinabox' to you system that give you SSH access in you web browser. | |||
docs/hassbian_config.md
Outdated
|
|
||
| ## Installation | ||
| ``` | ||
| $ curl https://api.github.com/repos/home-assistant/hassbian-scripts/releases/latest | grep "browser_download_url.*deb" | cut -d : -f 2,3 | tr -d \" | wget -qi - |
There was a problem hiding this comment.
This should be rewritten to recommend installing the image instead to reflect that it exists. The command line option could be left as an alternative but have a warning that if it's used with anything else than Raspbian or Hassbian it might not function as intended.
| @@ -0,0 +1,31 @@ | |||
| ## Description | |||
There was a problem hiding this comment.
This should be extended a bit.
Documentation about the flags like -y & -t are missing.
There was a problem hiding this comment.
When this PR was created, those flags did not exist :)
They are added now :)
docs/hassbian_config.md
Outdated
| hassbian-config *command* *suite* | ||
| ``` | ||
| where command is one of: | ||
| - `install` |
There was a problem hiding this comment.
Documentation about each command could be extended.
docs/hassbian_config.md
Outdated
| - `show` | ||
| - `log` | ||
| - `share-log` | ||
| - `install` Use this to isntall an suite. |
docs/hassbian_config.md
Outdated
| - `upgrade` Use this to upgrade an installed suite. | ||
| - `show` This will show you all available suites. | ||
| - `log` This wil show you the log of last hassbian-config operation. | ||
| - `share-log` This wil generate an hastebin link of the last hassbian-config operation. |
docs/hassbian_config.md
Outdated
| - `install` Use this to isntall an suite. | ||
| - `upgrade` Use this to upgrade an installed suite. | ||
| - `show` This will show you all available suites. | ||
| - `log` This wil show you the log of last hassbian-config operation. |
docs/hassbian_config.md
Outdated
| - `log` This wil show you the log of last hassbian-config operation. | ||
| - `share-log` This wil generate an hastebin link of the last hassbian-config operation. | ||
|
|
||
| optional flags: |
There was a problem hiding this comment.
Capital letter of Optional.
docs/hassbian_config.md
Outdated
|
|
||
| optional flags: | ||
| - `-y` This will accept defaults on scripts that allow this. | ||
| - `-f` This will force run an script, usefull is you try to install something a second time. |
There was a problem hiding this comment.
Recommend rephrasing this a bit.
"This will force run an script. This is useful if you need to reinstall a package."
docs/hassbian_config.md
Outdated
|
|
||
| ## Installation | ||
| This package is installed in the [HASSbian image](https://github.com/home-assistant/pi-gen/releases), so you do not need to install it there. | ||
| This will probably work on other distros also, but testing will only be done on HASSBian, therefor no support will be given if you choose to install it elsewhere. |
There was a problem hiding this comment.
Remove this line. I'm fairly certain it wont work on most others. An optional sentence.
This package is pre-installed on the [HASSbian image](https://github.com/home-assistant/pi-gen/releases).
This package can be used with Raspbian lite but it's not recommended.
Moved script documentation from README.md to /docs/*.md
Added an TOC (Table off content) to README.md
DEMO