Skip to content

Commit

Permalink
Documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
JMendyk committed Jan 30, 2018
1 parent c920ff3 commit 104433c
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@

![logicon_promo](demo/catchea_demo.gif)

## Documentation

Initial documentation (before implementing the project)
is available [here](https://github.com/JMendyk/catchea/blob/master/demo/catchea_pre_documentation.pdf).

Usage instructions are available below.

Dource code's documentation generated using Doxygen is [here](https://jmendyk.github.io/catchea/).

## Compile from sources

Requirements:
Expand Down Expand Up @@ -30,8 +39,13 @@ to improve build speed.
In project's root folder, directory `dist` will be created
with redistributable package.

Then download HGT data files for the app using `scripts/download_tiles.py` to
`res/assets/tiles` directory inside app's folder.

## Usage
When app starts it load example tile. To load own HGT files select "folder" icon it top-left
Compiled version of the app is available in [releases](https://github.com/JMendyk/catchea/releases) tab.

When app starts it loads example tile. To load own HGT files select "folder" icon it top-left
corner.

You can also load multiple files using Top menu's second option. This modules
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="intro"></a>
Introduction</h1>
<p>This documentation provides information about Catchea's source code to read initial and final documentation (in Polish) go <a href="google.com">here</a>. </p>
<p>This documentation provides information about Catchea's source code to read initial and final documentation (in Polish) go <a href="https://github.com/JMendyk/catchea/blob/master/demo/catchea_pre_documentation.pdf">here</a>. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
2 changes: 1 addition & 1 deletion src/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
*
* \section intro Introduction
* This documentation provides information about Catchea's source code
* to read initial and final documentation (in Polish) go <a href="google.com">here</a>.
* to read initial and final documentation (in Polish) go <a href="https://github.com/JMendyk/catchea/blob/master/demo/catchea_pre_documentation.pdf">here</a>.
*/

#define NDEBUG
Expand Down

0 comments on commit 104433c

Please sign in to comment.