search

terrapower / armicontrib-openmc

ARMI plugin for building and running OpenMC models
Apache License 2.0
6 stars 3 forks source link

Adding to READMEs #13

Closed john-science closed 2 months ago

john-science commented 4 months ago

I was thinking that adding two things to the README would be really helpful:

  1. A link to the OpenMC install guide. a. Did you use this? https://docs.openmc.org/en/stable/quickinstall.html
  2. How to run your test case. a. I assume it's this pointing to this, but giving a command line makes it easier for people new to this project.

Forgive me if you think this is obvious.

john-science commented 4 months ago

I'm just thinking aloud here.

AidanMcDonald commented 4 months ago

Great suggestions. I will link to both the quick install and the more detailed page [https://docs.openmc.org/en/stable/usersguide/install.html] which I've found more useful.

Running the test case is definitely not obvious at the moment, so I'll add good instructions for that too.

AidanMcDonald commented 3 months ago

The requested changes are up. Let me know if what I've added is sufficient and makes sense.