summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorꦌ ꦫꦶ ꦏ꧀ꦦꦿ ꦧ ꦮ ꦑ ꦩ ꦭ꧀ <erik@darapsa.co.id>2020-01-09 19:15:50 +0800
committerꦌ ꦫꦶ ꦏ꧀ꦦꦿ ꦧ ꦮ ꦑ ꦩ ꦭ꧀ <erik@darapsa.co.id>2020-01-09 19:15:50 +0800
commit7056eaa251df33e178c21e0fb29c6d65bc2c9147 (patch)
tree31919100ef9f77317799eea189e9f97e892ead1b
parent1c84df234cb0df735b6c8959018b08d8bfefca50 (diff)
Get around the double level 1 header bug
in Doxygen
-rw-r--r--Doxyfile2
-rw-r--r--README.md16
2 files changed, 7 insertions, 11 deletions
diff --git a/Doxyfile b/Doxyfile
index d15459c..e760940 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -44,7 +44,7 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF = "Native interface written in C for interacting with Interchange servers"
+PROJECT_BRIEF =
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
diff --git a/README.md b/README.md
index 0b0ea26..8d656b0 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,8 @@
-# libicclient
+# Native (non-web) interface written in C for interacting with [Interchange](https://interchangecommerce.org) servers
-## Overview
+# Building
-Native (non-web) interface for interacting with [Interchange](https://interchangecommerce.org) servers.
-
-## Building
-
-### Getting and preparing for configuration
+## Getting and preparing for configuration
```sh
$ git clone git://darapsa.org/libicclient.git
@@ -14,14 +10,14 @@ $ cd libicclient
$ autoreconf --install
```
-### Optionally setting environment values
+## Optionally setting environment values
```sh
$ export CFLAGS="${CFLAGS} -g -DDEBUG -DANDROID -fPIC" # PIC might be needed later on android_armv7
$ export LDFLAGS="${LDFLAGS} -llog" # Android liblog
```
-### Configuring for various target hosts
+## Configuring for various target hosts
```sh
$ ./configure
@@ -41,7 +37,7 @@ $ CC=/usr/local/arm-linux-androideabi/bin/arm-linux-androideabi-clang ./configur
or so on.
-### Compiling and linking
+## Compiling and linking
```sh
$ make # -jN (with N an integer number of parallel tasks you allow your computer to run for compiling this)