Browse Source

modifying the readme

Patrik Kovacs 6 năm trước cách đây
mục cha
commit
1157233e04
1 tập tin đã thay đổi với 40 bổ sung1 xóa
  1. 40 1
      README.md

+ 40 - 1
README.md

@@ -162,4 +162,43 @@ This specific exception has **getType** and **getClassType** methods,
 just to get information about the thrower object.
 Has a **getExceptionType** which returns information about the type
 of the exception, and a **getMessage** method which returns a message
-as string.
+as string.
+
+## Supported compilers
+```
+g++
+clang++
+msvc
+```
+
+## Build instructions
+
+The hdf4 C library is needed to be installed.
+
+```bash
+mkdir build
+cd build
+cmake ..
+make
+```
+
+## Install
+
+```bash
+make install
+```
+
+## Generating documentation
+
+1. Generating the user documentation.
+It includes documentation which is necessary for using this library.
+
+```bash
+make docs_user
+```
+
+2. Generating the whole documentations.
+
+```bash
+make docs_all
+```