docs(readme): updated readme to include details on test config
This commit is contained in:
19
Readme.md
19
Readme.md
@@ -18,6 +18,25 @@ if you want to build with no test suite run
|
|||||||
```bash
|
```bash
|
||||||
./mk --noTest
|
./mk --noTest
|
||||||
```
|
```
|
||||||
|
If you do not want to use the mk script you can also use the `4DSSEConsole` which is just a simple bash script can help with building and debugging
|
||||||
|
```bash
|
||||||
|
./4DSSEConsole.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Finally, if you just want to use meson directly you can do the following
|
||||||
|
|
||||||
|
To not run tests
|
||||||
|
```bash
|
||||||
|
meson setup build
|
||||||
|
meson compile -C build
|
||||||
|
```
|
||||||
|
If you want to run tests
|
||||||
|
```bash
|
||||||
|
meson test -C build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Test Configuration
|
||||||
|
Some tests use config variables setup in tests/testsConfig.yaml. Specifically for things like the GLVis host and port. You should configre those to point to whatever host you are running GLVis on.
|
||||||
|
|
||||||
## Current Status
|
## Current Status
|
||||||
Currently we are working on implimenting modules such as opacity, equation of state, polytrope, and meshing. Builds may not work on any branches at any time.
|
Currently we are working on implimenting modules such as opacity, equation of state, polytrope, and meshing. Builds may not work on any branches at any time.
|
||||||
|
|||||||
Reference in New Issue
Block a user