Add reminder to recompile upon source code changes and to post instal…

…lation issues online
arfc · May 30, 2022 · 2dfe790 · 2dfe790
1 parent 9f3c6d8
commit 2dfe790
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/doc/content/development/contributing.md b/doc/content/development/contributing.md
@@ -72,6 +72,10 @@ understand your changes without having to read code. *Commit early and often* to
 that you can revert to if you break something while implementing your changes. Frequent commits
 also helps to keep your commits short and sweet.
 
+!alert note
+Remember to [compile](installation.md#compile) Moltres again after making changes to the source code to 
+run and test your new build.
+
 If you have been working on your changes for some time, there may have been new updates to Moltres
 implemented by others since the last time you pulled from the `upstream` remote. Merge those
 updates into your local `devel` and working branches by running the following commands.

diff --git a/doc/content/getting_started/installation.md b/doc/content/getting_started/installation.md
@@ -33,7 +33,7 @@ git submodule init
 git submodule update
 ```
 
-## 3. Compile and Test Moltres
+## 3. Compile and Test Moltres id=compile
 
 Before proceeding with this step, check that the Conda MOOSE environment is activated in your
 current terminal. This is achieved by running the following command every time you open a new
@@ -55,10 +55,14 @@ You may also compile a debug version of Moltres by running `METHOD=dbg make
 -j8`. Note that you should replace `8` with the number of processors available
 on your machine.
 
+If you encounter any problems with installation, please post on our
+[GitHub Discussions](https://github.com/arfc/moltres/discussions) page along with the full error
+message so that we can help you troubleshoot your installation.
+
 ## 4. Running Moltres Simulations
 
-If you have successfully compiled Moltres, you should have a `moltres-opt` executable in the
-`~\projects\moltres` directory. To run your input file, use the following command:
+If you have successfully completed the previous step, you should have a `moltres-opt` executable in
+the `~\projects\moltres` directory. To run a Moltres input file, use the following command:
 
 ```bash
 ~/projects/moltres/moltres-opt -i input-file.i