Skip to content

Commit 43957d8

Browse files
committed
Update README.md style
1 parent 612dbac commit 43957d8

File tree

1 file changed

+28
-24
lines changed

1 file changed

+28
-24
lines changed

README.md

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,35 @@
11
# ImportMesh
2+
23
Utilities for importing FEM meshes to Mathematica. Currently supported file formats:
34

4-
- .inp ([Abaqus](https://www.3ds.com/products-services/simulia/products/abaqus/))
5-
- .mes ([Elfen](http://www.rockfieldglobal.com/))
6-
- .msh ([Gmsh](http://gmsh.info/))
7-
- .mphtxt ([Comsol](https://www.comsol.com/))
5+
- .inp ([Abaqus](https://www.3ds.com/products-services/simulia/products/abaqus/))
6+
- .mes ([Elfen](http://www.rockfieldglobal.com/))
7+
- .msh ([Gmsh](http://gmsh.info/))
8+
- .mphtxt ([Comsol](https://www.comsol.com/))
89

910
## Installation
1011

11-
The following description is for people who just want to use the package functionality and
12-
are not interested in package development.
12+
The following description is for people who just want to use the package
13+
functionality and are not interested in package development.
14+
1315
To use _ImportMesh_ package you need Mathematica version 11. or later.
1416

15-
_ImportMesh_ package is released in the `.paclet` file format, which contains code,
16-
documentation and other necesseary resources.
17-
Download the latest `.paclet` file from the [repository "releases" page](https://github.com/c3m-labs/ImportMesh/releases)
17+
_ImportMesh_ package is released in the `.paclet` file format, which contains code,
18+
documentation and other necessary resources.
19+
Download the latest `.paclet` file from the [repository "releases" page](https://github.com/c3m-labs/ImportMesh/releases)
1820
to your computer and install it by evaluating the following command in the Mathematica:
1921

2022
```mathematica
21-
(* This is ussualy loaded automatically at kernel startup. *)
22-
Needs["PacletManager`"]
23+
(* This is usually loaded automatically at kernel startup. *)
24+
Needs["PacletManager`"]
2325
2426
(* Download .paclet file from repository "releases" page. *)
25-
PacletInstall["full/path/to/ImportMesh-X.Y.Z.paclet"]
27+
PacletInstall["full/path/to/ImportMesh-X.Y.Z.paclet"]
2628
```
2729

28-
This will permanently install the _ImportMesh_ package to `$UserBasePacletsDirectory`.
30+
This will permanently install the _ImportMesh_ package to `$UserBasePacletsDirectory`.
2931
To update the documentation it may be necessary to restart Mathematica.
30-
Mathematica will always use the latest installed version of package and all installed versions
32+
Mathematica will always use the latest installed version of package and all installed versions
3133
can be enumerated by evaluating `PacletFind["ImportMesh"]`.
3234
You can get more detailed information about the package with `PacletInformation["ImportMesh"]`.
3335
All versions can be uninstalled with:
@@ -36,11 +38,12 @@ All versions can be uninstalled with:
3638
PacletUninstall["ImportMesh"]
3739
```
3840

39-
Alternately load the package directly from online repository by running `Get["https://raw.githubusercontent.com/c3m-labs/ImportMesh/master/ImportMesh.wl"]`.
41+
Alternately load the package directly from online repository by running
42+
`Get["https://raw.githubusercontent.com/c3m-labs/ImportMesh/master/ImportMesh.wl"]`.
4043

4144
## Usage
4245

43-
**Basic**
46+
### Basic
4447

4548
The only (currently) public function is `ImportMesh`. It creates `ElementMesh` object from a text file:
4649

@@ -53,11 +56,11 @@ mesh["Wireframe"]
5356

5457
![screenshot](https://imgur.com/aq92uqA.gif "Geometry source: https://grabcad.com/library/goose-2")
5558

56-
**Advanced**
59+
### Advanced
5760

58-
There are also functions in the ``"`Package`"`` subcontext that implement `ImportMesh`.
59-
Similarly, support is added for `Import` registration, so it is possible to import a file as an `"ElementMesh"` and get it to work as expected.
60-
For example:
61+
There are also functions in the ``"`Package`"`` subcontext that implement `ImportMesh`.
62+
Similarly, support is added for `Import` registration, so it is possible to import a file as an
63+
`"ElementMesh"` and get it to work as expected. For example:
6164

6265
```mathematica
6366
@@ -119,10 +122,11 @@ More information on how to manipulate and visualize `ElementMesh` objects is ava
119122

120123
## Contributions
121124

122-
Contributions to ImportMesh package are very welcome. You can open a [new issue](https://github.com/c3m-labs/ImportMesh/issues/new) with bug report or feature request.
125+
Contributions to ImportMesh package are very welcome.
126+
You can open a [new issue](https://github.com/c3m-labs/ImportMesh/issues/new) with bug report or feature request.
123127

124128
These are some things you can help with:
125129

126-
- Test package with different mesh files
127-
- Provide sample mesh files from other, not yet supported, software
128-
- Propose code improvements (style or performance)
130+
- Test package with different mesh files
131+
- Provide sample mesh files from other, not yet supported, software
132+
- Propose code improvements (style or performance)

0 commit comments

Comments
 (0)