Separate build install readme #105
Conversation
| <summary><b>Expand</b> - Ubuntu terminal commands for Ubuntu 20.04</summary> | ||
| <pre><code class="language-html"> | ||
| wget https://github.com/svalinn/Cubit-plugin/releases/download/0.1.0/svalinn-plugin_ubuntu-20.04_cubit_2021.5.tgz | ||
| sudo tar -xzvf svalinn-plugin_ubuntu-20.04_cubit_2021.5.tgz -C /opt/Coreform-Cubit-2021.5 |
There was a problem hiding this comment.
This is only valid for Ubuntu, I think.
There was a problem hiding this comment.
Yep I think so also, it mentions Ubuntu usage in the Expansion tab.
I did this via an expand tabs as I think we could have expand tabs for every OS once they are all working.
Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>
…bit-plugin into separate_build_install_readme
|
Those failing test should not hold the merge of this as it is documentation change only |
Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>
Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>
Co-authored-by: Baptiste Mouginot <15145274+bam241@users.noreply.github.com>
README.md
Outdated
| @@ -243,32 +64,22 @@ Cubit> | |||
|
|
|||
| If this output does not appear, then the plugin was not installed correctly. | |||
There was a problem hiding this comment.
this is not true on MacOS with Cubit 2021.5
There was a problem hiding this comment.
here is my command input:
Finished Command: undo on
Cubit>help dagmc
Help for words: dagmc.
export dagmc <filename> [faceting_tolerance <faceting tolerance>] [length_tolerance <length tolerance>]
[normal_tolerance <normal tolerance>] [make_watertight] [verbose]
[fatal_on_curves]
Help for words: dagmc.
export dagmc <filename> [faceting_tolerance <faceting tolerance>] [length_tolerance <length tolerance>]
[normal_tolerance <normal tolerance>] [make_watertight] [verbose]
[fatal_on_curves]
Cubit>
not Loaded Svalinn plugin input but help dagmc worked just fine
There was a problem hiding this comment.
ok I can perhaps change it to something like ...
Run coreform_cubit from the command line. After the Cubit GUI finishes loading, run the following command in the Cubit command line:
help dagmcIf the plugin was installed correctly you should see the following text appear.
Help for words: dagmc.
export dagmc <filename> [faceting_tolerance <faceting tolerance>] [length_tolerance <length tolerance>]
[normal_tolerance <normal tolerance>] [make_watertight] [verbose]
[fatal_on_curves]
If this output does not appear, then the plugin was not installed correctly.
|
Perhaps this documentation update is ready to merge |
|
Thanks @shimwell - This one is definitely ready to merge! (documentation is asymptotic - we can always find things to tweak, and then PR's languish) |
As discussed in the DAGMC community meeting today.
The Readme contains more advanced build instructions that the average user will not need.
Therefore the README has been split into two parts, one for simple installation and one for the more complex build.
The testing section was also in need on a split and the more advanced part of the testing is has been moved to the test_plugin folder where it will render as the main readme for that url
Just worth mentioning that the README files have links between them which will not work on this PR as they link to the develop branch version of themselves :-)