From 496a82d1bd5585eab3df47af7c15992a84ef0078 Mon Sep 17 00:00:00 2001 From: jvgomez Date: Tue, 3 Mar 2015 15:37:33 +0100 Subject: [PATCH] Doc improved --- doc/TODO | 1 + doc/{ => files}/nDGridMap.pdf | Bin doc/markdown/main.md | 2 +- 3 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 doc/TODO rename doc/{ => files}/nDGridMap.pdf (100%) diff --git a/doc/TODO b/doc/TODO new file mode 100644 index 0000000..7a6279b --- /dev/null +++ b/doc/TODO @@ -0,0 +1 @@ +Create a CMakeLists.txt here so that the files folder is automatically copied into html/ once doxygen is run. diff --git a/doc/nDGridMap.pdf b/doc/files/nDGridMap.pdf similarity index 100% rename from doc/nDGridMap.pdf rename to doc/files/nDGridMap.pdf diff --git a/doc/markdown/main.md b/doc/markdown/main.md index a197232..eed36df 100644 --- a/doc/markdown/main.md +++ b/doc/markdown/main.md @@ -5,4 +5,4 @@ This pages provide basic documentation about the Fast Marching code packages I h - [Software design](markdown/design.md) - [Detailed building](markdown/building.md) - [Benchmarking](markdown/benchmarking.md) -- [nDGridMap implementation](../nDGridMap.pdf): Probably, the most complex part of the code. It encapsulates the complexity of the n-dimensional generalization, so that solvers are implemented almost independently of the number of dimensions. \ No newline at end of file +- [nDGridMap implementation](files/nDGridMap.pdf): Probably, the most complex part of the code. It encapsulates the complexity of the n-dimensional generalization, so that solvers are implemented almost independently of the number of dimensions. \ No newline at end of file