updated README #51
updated README #51
Conversation
There was a problem hiding this comment.
This is looking good - thanks @engineerjoe440!
A few small changes and we can merge it.
README.md
Outdated
|
|
||
| 1. Preferably using non-system Python, set up an environment using, e.g., miniconda: | ||
| ```bash | ||
| $ conda create -n blark-env python=3.7 |
There was a problem hiding this comment.
Looks like I added blark to conda-forge since I last updated the README (ages ago...).
This step on conda can now be done in a single go:
| $ conda create -n blark-env python=3.7 | |
| $ conda create -n blark-env -c conda-forge python=3.7 blark |
Which means that the pip install is only necessary for virtualenv / system python / non-conda environments.
I'd say let's break this up into two sections:
- Here's how to install blark with conda (using the line above)
- Here's how to install blark in a virtualenv (using standard library venv: guide)
| ``` | ||
|
|
||
| For some additional reference regarding this syntax, refer to | ||
| [the comment here on issue #20](https://github.com/klauer/blark/issues/20#issuecomment-1099699641) |
There was a problem hiding this comment.
I did write a nice little comment there 😁
Maybe that comment should be reformatted as part of the docs or the wiki. I'll make an issue to put some sphinx docs in the repo. (I usually do it by default with my other projects so I'm a bit surprised to not even find a docs/ directory here...)
| > RuSTy is a structured text (ST) compiler written in Rust. RuSTy utilizes the LLVM framework to compile eventually to native code. | ||
| - [IEC Checker](https://github.com/jubnzv/iec-checker) - Static analysis tool | ||
| for IEC 61131-3 logic. As described by the maintainer: | ||
| > iec-checker has the ability to parse ST source code and dump AST and CFG to JSON format, so you can process it with your language of choice. |
There was a problem hiding this comment.
Let's also add in TcBlack:
https://github.com/Roald87/TcBlack Python black-like code formatter for TwinCAT code
There was a problem hiding this comment.
Great! That's a good one... added!
Co-authored-by: Ken Lauer <klauer@users.noreply.github.com>
Co-authored-by: Ken Lauer <klauer@users.noreply.github.com>
Co-authored-by: Ken Lauer <klauer@users.noreply.github.com>
|
Thanks again, @klauer! Forgive my delay in getting back to updating things here. Got caught up with some stuff at work, and this fell off my radar. 😦 But I'm glad to add the points you've made! Let me know if there's anything else I should address. 😄 |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #51 +/- ##
========================================
+ Coverage 71.8% 72.0% +0.2%
========================================
Files 18 18
Lines 3772 3772
========================================
+ Hits 2710 2719 +9
+ Misses 1062 1053 -9 |
There was a problem hiding this comment.
Looks good!
The quickstart section still needs a bit of work (#51 (comment) - there's a bit more in this comment about the conda/venv stuff - but let's get this change in and leave that for another PR.
Changes
Largely targeted at adding some additional documentation in relation to several of the outstanding issues.
Issues Addressed
I should add that I'm totally just throwing this out at you, so feel free to push back on anything... phrasing, terminology, anything!