diff --git a/README.md b/README.md index 80cf68d7bc..914792ac9b 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,19 @@ 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.
+Table of Contents +==================== +- [Aknowledgements](#aknowledgements)
+- [Relevant Papers](#relevant-papers)
+- [Requirements](#requirements)
+- [Building](#building)
+ - [Unix/OSX](#unix-and-osx)
+ - [Windows](#windows)
+- [Running](#running)
+ - [ShapeWorksGroom](#shapeworksgroom)
+ - [ShapeWorksRun](#shapeworksrun)
+ - [ShapeWorksView2](#shapeworksview2)
+- [Contact and Bug Reports](#contact-and-bug-reports)

Aknowledgements

If you use ShapeWorks in work that leads to published research, we humbly ask that you add the @@ -19,7 +32,7 @@ following to the 'Acknowledgments' section of your paper: "This project was supp National Institute of General Medical Sciences of the National Institutes of Health under grant number P41GM103545." -

Relevant Papers

+

Relevant Papers

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

Unix / OSX

+

Unix and OSX

In a terminal: ```c++ mkdir shapeworks/build @@ -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.