Creating Docs folder and improving README. #131
Conversation
…into issue-101-docs
docs/getting-started.md
Outdated
| 5. Run it | ||
|
|
||
| ```bash | ||
| atsc -csv <input-file> |
There was a problem hiding this comment.
This should probably be: cargo run --release -- -csv <input-file>
Or otherwise have a prereq step that copies target/release/atsc to atsc
There was a problem hiding this comment.
Is the diff confusing me or was this not addressed?
There was a problem hiding this comment.
I addressed it in the README.md not on this file -_-.
I need to do a release, I'll fix it there.
added iowait.csv fixed getting-started.md
| @@ -36,11 +66,11 @@ Internally ATSC uses the following methods for time series fitting: | |||
| * Interpolation - Catmull-Rom | |||
| * Interpolation - Inverse Distance Weight | |||
|
|
|||
| For a more detailed insight into ATSC read the paper here: [ATSC - A novel approach to time-series compression](https://some.url.com) | |||
| For a more detailed insight into ATSC read the paper here: [ATSC - A novel approach to time-series compression](https://github.com/instaclustr/atsc/tree/main/paper/ATCS-AdvancedTimeSeriesCompressor.pdf) | |||
There was a problem hiding this comment.
It seems that the PDF is not available for now
There was a problem hiding this comment.
Ok, it will be valid once we merge. It is pointing to main branch.
atsc/demo/run_demo.sh
Outdated
| array_data=$(echo $file_content | grep -oP '\[.*?\]') | ||
| js_array="const idwData = $array_data;" | ||
| echo "$js_array" >> $htmlfile | ||
|
|
||
| file_content=$(<tmp_poly.txt) | ||
| array_data=$(echo $file_content | grep -oP '\[.*?\]') | ||
| js_array="const polyData = $array_data;" | ||
| echo "$js_array" >> $htmlfile |
There was a problem hiding this comment.
It seems that file_content indentations can be adjusted here
atsc/demo/run_demo_csv.sh
Outdated
| file_content=$(<tmp_idw.txt) | ||
| array_data=$(echo $file_content | grep -oP '\[.*?\]') | ||
| js_array="const idwData = $array_data;" | ||
| echo "$js_array" >> $htmlfile | ||
|
|
||
| file_content=$(<tmp_poly.txt) | ||
| array_data=$(echo $file_content | grep -oP '\[.*?\]') | ||
| js_array="const polyData = $array_data;" | ||
| echo "$js_array" >> $htmlfile |
There was a problem hiding this comment.
It seems that file_content indentations can be adjusted here also
|
LGTM! |
This PR adds proper DOCs and improves the README based on feedback.