Skip to content

Commit

Permalink
Add hyperlink to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pedropark99 committed Mar 5, 2024
1 parent d267bbe commit ecd0ff5
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ was drawn into the flow field.

# A minimal example

The complete example can be found inside the `examples` directory of this repository.
The complete example can be found inside the [`examples`](https://github.com/The-Erebor-Foundry/lefer/tree/main/examples) directory of this repository.
But just as a minimal example.

```cpp
Expand Down
2 changes: 1 addition & 1 deletion docs/html/md_README.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h1><a class="anchor" id="autotoc_md3"></a>
<p>Both functions return a <code>std::vector</code> of <code><a class="el" href="classlefer_1_1Curve.html">lefer::Curve</a></code> objects. Each <code><a class="el" href="classlefer_1_1Curve.html">lefer::Curve</a></code> object represents a curve that was drawn into the flow field.</p>
<h1><a class="anchor" id="autotoc_md4"></a>
A minimal example</h1>
<p>The complete example can be found inside the <code>examples</code> directory of this repository. But just as a minimal example.</p>
<p>The complete example can be found inside the <a href="https://github.com/The-Erebor-Foundry/lefer/tree/main/examples"><code>examples</code></a> directory of this repository. But just as a minimal example.</p>
<div class="fragment"><div class="line"><span class="keywordtype">int</span> flow_field_width = 120;</div>
<div class="line"><span class="keywordtype">int</span> flow_field_height = 120;</div>
<div class="line"><span class="keywordtype">int</span> n_steps = 30;</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/latex/md_README.tex
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
This library offers a single function for each part ({\ttfamily \mbox{\hyperlink{namespacelefer_aea61e23cac090b41eedfb4b4b483631b}{lefer\+::even\+\_\+spaced\+\_\+curves()}}} and {\ttfamily \mbox{\hyperlink{namespacelefer_ab061cf97ccaa1b5105ac39aa2e44073a}{lefer\+::non\+\_\+overlapping\+\_\+curves()}}}). So, if you want to draw curves that do not overlap each other, but you do not care about how much far they are from each other, you probably want to use the {\ttfamily \mbox{\hyperlink{namespacelefer_ab061cf97ccaa1b5105ac39aa2e44073a}{lefer\+::non\+\_\+overlapping\+\_\+curves()}}} function. Otherwise, you use the {\ttfamily \mbox{\hyperlink{namespacelefer_aea61e23cac090b41eedfb4b4b483631b}{lefer\+::even\+\_\+spaced\+\_\+curves()}}}.

Both functions return a {\ttfamily std\+::vector} of {\ttfamily \mbox{\hyperlink{classlefer_1_1Curve}{lefer\+::\+Curve}}} objects. Each {\ttfamily \mbox{\hyperlink{classlefer_1_1Curve}{lefer\+::\+Curve}}} object represents a curve that was drawn into the flow field.\hypertarget{md_README_autotoc_md4}{}\doxysection{A minimal example}\label{md_README_autotoc_md4}
The complete example can be found inside the {\ttfamily examples} directory of this repository. But just as a minimal example.
The complete example can be found inside the \href{https://github.com/The-Erebor-Foundry/lefer/tree/main/examples}{\texttt{ {\ttfamily examples}}} directory of this repository. But just as a minimal example.


\begin{DoxyCode}{0}
Expand Down

0 comments on commit ecd0ff5

Please sign in to comment.