Update README from Mat #14
Conversation
I have updated the README document as requested Shota, I added in a few new fields as well :)
| @@ -50,25 +50,73 @@ You should start 4 instances parallel. | |||
| Instance 1 | |||
|
|
|||
| ``` | |||
| First run | |||
| brew install librdkafka | |||
|
|
|||
There was a problem hiding this comment.
also line brake is not necessary
README.md
Outdated
| brew services list | ||
|
|
||
| then run | ||
| git branch |
There was a problem hiding this comment.
these git commands are not necessary.
README.md
Outdated
| mosquitto -c config/mosquitto.conf | ||
|
|
||
| and | ||
| brew services start mosquitto |
There was a problem hiding this comment.
this command is not necessary as mosquitto -c config/mosquitto.conf will take care of this.
| ``` | ||
|
|
||
| Instance 2 | ||
|
|
||
| ``` | ||
| cd ssa_iot | ||
|
|
There was a problem hiding this comment.
also please remove the line brake for consistency. Please apply to all the code section.
README.md
Outdated
| To monitor commands in MQTT use the below command in a new terminal | ||
|
|
||
| ``` | ||
| mosquitto_sub -t "#" -h localhost -v |
There was a problem hiding this comment.
For the security reasons, this has to be blocked by the access control (I have changed your config file (config/mosquitto.conf by changing allow_annonymous false to true to remove the access control). So we do not allow this for this assignment.
|
@mvbeek I have checked your readme, I haven't commented to all the lines but please modify the following.
|
| @@ -16,7 +16,7 @@ The following should be installed already before setup. | |||
| ## Install Necessary Source Code and Libraries | |||
|
|
|||
| ``` | |||
| git clone https://github.com/ShotaKameyama/ssa_iot.git` | |||
| git clone https://github.com/ShotaKameyama/ssa_iot.git | |||
There was a problem hiding this comment.
extra ` which when copied made the code not work when copied.
| @@ -37,10 +37,10 @@ This shell script will take care of the following: | |||
| 4. Add Environment Variables to `~/.bash_profile` | |||
|
|
|||
|
|
|||
| # Basic Inforamtion | |||
| # Basic Information | |||
|
|
||
| This IoT system consists of 4 instances: | ||
| - MQTT braker | ||
| - MQTT broker |
Hi Shota, I have made changes as requested.
|
|
||
| git log | ||
| git pull | ||
|
|
| mosquitto -c config/mosquitto.conf | ||
|
|
There was a problem hiding this comment.
This blank line is not necessary.
| cd ssa_iot | ||
|
|
||
| source ~/.bash_profile | ||
|
|
There was a problem hiding this comment.
This blank line is not necessary.
| ``` | ||
| cd ssa_iot | ||
|
|
There was a problem hiding this comment.
This blank line is not ncecessary
| cd ssa_iot | ||
|
|
||
| source ~/.bash_profile | ||
|
|
There was a problem hiding this comment.
This blank line is not necessary
I have updated the README document as requested Shota, I added in a few new fields as well and corrected some spelling mistakes :)