Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brigb123 committed Jun 17, 2015
1 parent dfd6826 commit 78a7671
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,27 @@ minimization that balances the simplicity of the model (compactness) with the ac
surface representations. The ShapeWorks software includes tools for preprocessing data, computing
point-based shape models, and visualizing the results.
<br/>
Table of Contents
====================
- [Aknowledgements](#aknowledgements)<br/>
- [Relevant Papers](#relevant-papers)<br/>
- [Requirements](#requirements)<br/>
- [Building](#building)<br/>
- [Unix/OSX](#unix-and-osx)<br/>
- [Windows](#windows)<br/>
- [Running](#running)<br/>
- [ShapeWorksGroom](#shapeworksgroom)<br/>
- [ShapeWorksRun](#shapeworksrun)<br/>
- [ShapeWorksView2](#shapeworksview2)<br/>
- [Contact and Bug Reports](#contact-and-bug-reports)<br/>

<h3>Aknowledgements</h3>
If you use ShapeWorks in work that leads to published research, we humbly ask that you add the
following to the 'Acknowledgments' section of your paper: "This project was supported by the
National Institute of General Medical Sciences of the National Institutes of Health under
grant number P41GM103545."

<h3> Relevant Papers </h3>
<h3>Relevant Papers</h3>

The following selected papers give background on the methods used in ShapeWorks and a
sample of the areas ShapeWorks has been applied:
Expand Down Expand Up @@ -54,7 +67,7 @@ Requirements

Building
=====================
<h3>Unix / OSX</h3>
<h3>Unix and OSX</h3>
In a terminal:
```c++
mkdir shapeworks/build
Expand Down Expand Up @@ -169,6 +182,6 @@ building meshes. This speeds reconstruction, theoretically.
There are a few Import/Export options under the File Menu. The details of these options are
beyond the scope of this document.

Contact / Bug Reports
Contact and Bug Reports
=====================
Please email any questions to Shapeworks-users@sci.utah.edu . If there problems or bugs, please report them using the issue tracker on GitHub. This includes feature requests. Feel free to add improvements using git pull requests.

0 comments on commit 78a7671

Please sign in to comment.