Skip to content

Commit

Permalink
updating README to README.md to be able to link to docker
Browse files Browse the repository at this point in the history
and moving docker config into config/docker so it renders nicely!

Signed-off-by: vsoch <vsoch@users.noreply.github.com>
  • Loading branch information
vsoch committed Apr 30, 2022
1 parent 9a57c46 commit 8be4ab8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README → README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```
Finite Element Discretization Library
__
_ __ ___ / _| ___ _ __ ___
Expand All @@ -7,13 +8,15 @@
https://mfem.org
```

MFEM is a modular parallel C++ library for finite element methods. Its goal is
to enable high-performance scalable finite element discretization research and
application development on a wide variety of platforms, ranging from laptops to
supercomputers.

We welcome contributions and feedback from the community. Please see the file
CONTRIBUTING.md for additional details about our development process.
[CONTRIBUTING.md](CONTRIBUTING.md) for additional details about our development process.

* For building instructions, see the file INSTALL, or type "make help".

Expand All @@ -22,6 +25,8 @@ CONTRIBUTING.md for additional details about our development process.
* The best starting point for new users interested in MFEM's features is to
review the examples and miniapps at https://mfem.org/examples.

* Instructions for learning with docker are [here](config/docker)

Conceptually, MFEM can be viewed as a finite element toolbox that provides the
building blocks for developing finite element algorithms in a manner similar to
that of MATLAB for linear algebra methods. In particular, MFEM provides support
Expand Down Expand Up @@ -61,6 +66,8 @@ additional linear and nonlinear solvers, preconditioners, time integrators, etc.
For examples of using MFEM, see the examples/ and miniapps/ directories, as well
as the OpenGL visualization tool GLVis which is available at https://glvis.org.

## License

MFEM is distributed under the terms of the BSD-3 license. All new contributions
must be made under this license. See LICENSE and NOTICE for details.

Expand Down
File renamed without changes.

0 comments on commit 8be4ab8

Please sign in to comment.