diff --git a/README.md b/README.md index d8b15c1ca9c6852d933465e2919b98ade68ab867..7712995f91e99496bda455fe922e072c822a9616 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ to run this progrom all you need to do is: To run this program all you need to do is: 0. Open a terminal change to this directory -1. type** make** to compile (Note: uses gcc) -2. type** ./test **to begin +1. type **make** to compile (Note: uses gcc) +2. type **./test** to begin 3. enter size of packet 4. enter each index (0x__) separated by enter presses 5. check my result :) @@ -27,12 +27,12 @@ if for some reason things dont work try **/make clean ** and repeat the steps. Functions I wrote and their purpose: -- **int main(void)**: main loop that gathers user inputs as packet data to be +- **int main(void)** : main loop that gathers user inputs as packet data to be distinguished. This function calls Distinguish(uint8_t *data) and then checks wether this function was successful at reading the data. -- **int Distinguish(uint8_t *data)**: Takes a pointer to the data packet and then +- **int Distinguish(uint8_t *data)** : Takes a pointer to the data packet and then looks into the data to find the message_type, length, and ID. Then check the message type to be Display (x34), motor message (x80) or neither. If the message type is known then @@ -44,12 +44,12 @@ Functions I wrote and their purpose: -1 if the packet has invalid data type or message_type -- **void display_message(char* message, uint16_t message_length)**: +- **void display_message(char* message, uint16_t message_length)** : This function first prompts to the user that this specific function was called. Then displays the message in ASCII by looping through the char array/string. -- **void update_motor(int32_t forwardback, int32_t leftright)**: +- **void update_motor(int32_t forwardback, int32_t leftright)** : This function first prompts the user that this specific function was called. Then it displays the forward_back and left_right data as a signed integer.