Skip to content

Commit 0920f0e

Browse files
RomanHeinRomanHein
committed
Update documentation
1 parent fd614c1 commit 0920f0e

3 files changed

Lines changed: 12 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
1+
# Table of content
2+
* [Installation guide](docs/installation.md)
3+
* [API documentation](docs/API.md)

‎docs/API.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# filemanager

‎docs/installation.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Requirements
2+
* C++17 or later
3+
* 64-bit system
4+
5+
# Installation
6+
1. Download the latest release
7+
2. Extract the **filemanager.h** file from `include/filemanager.h` into your project folder
8+
3. Include the header in your code e.g. `#include "filemanager.h"`

0 commit comments

Comments
 (0)