Add example.

Author: ChenPi11

CMakeLists.txt

@@ -1,19 +1,28 @@
 cmake_minimum_required(VERSION 3.10)
 project(cppp-platform VERSION 1.3.0)
 
+option(BUILD_EXAMPLE "Build example" OFF)
+
 # Read source files
 file(READ "${CMAKE_CURRENT_SOURCE_DIR}/src/architectures.h" ARCHITECTURES)
 file(READ "${CMAKE_CURRENT_SOURCE_DIR}/src/compilers.h" COMPILERS)
 file(READ "${CMAKE_CURRENT_SOURCE_DIR}/src/languagestandards.h" LANGUAGESTANDARDS)
 file(READ "${CMAKE_CURRENT_SOURCE_DIR}/src/platforms.h" PLATFORMS)
 
 # Genetate header
-configure_file("${CMAKE_CURRENT_SOURCE_DIR}/include/cppp/cppp-platform.h.in" "${output_includedir}/cppp/cppp-platform.h")
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/include/cppp/cppp-platform.h.in" "${CMAKE_BINARY_DIR}/include/cppp/cppp-platform.h")
+
+# Build example
+if(BUILD_EXAMPLE)
+    add_executable(example "${CMAKE_CURRENT_SOURCE_DIR}/src/example.c")
+    target_include_directories(example PRIVATE "${CMAKE_BINARY_DIR}/include")
+endif()
+
 
 # Install
 # Includes
 # PERMISSIONS 0644
-install(FILES "${output_includedir}/cppp/cppp-platform.h"
-        DESTINATION "${install_includedir}"
+install(FILES "${CMAKE_BINARY_DIR}/include/cppp/cppp-platform.h"
+        DESTINATION "${CMAKE_INSTALL_PREFIX}/include"
         RENAME "cppp/cppp-platform.h"
         PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ )

README.md

@@ -1,39 +1,22 @@
-# Introduction
-cppp-platform is a portable platform check library for C+++.
+# cppp-platfrom -- Portable platform check library
+
+## Build
+
+### Dependencies
 
-# Build
-## Dependence
 + CMake (version >= 3.10)
 
-## Command
+### Command
+
 ```shell
 mkdir build
 cd build
 cmake .. -DCMAKE_INSTALL_PREFIX=[[PREFIX]]
+# If you want to build the example, add -DBUILD_EXAMPLE=ON
 cmake --build .
 cmake --install .
 ```
 
-# Example
-After install, you can use cppp-platform in C/C++
-```c
-#include <cppp/cppp-platform.h>
-#include <stdio.h>
-int main()
-{
-    if(__has_windows__)
-    {
-        printf("Compile in Windows!\n");
-    }
-    else
-    {
-        printf("Compile non-Windows!\n");
-    }
-    printf("Target arch:%s\n",__arch__);
-    printf("Target arch name:%s\n",__arch_name__);
-    printf("Pointer width:%d\n",__POINTER_WIDTH__);
-}
-```
+## Documentation
 
-# Manual
-[User Manual](doc/doc.md)
+[Documentation](doc/doc.md)

src/example.c

@@ -0,0 +1,27 @@
+#include <cppp/cppp-platform.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+
+int main(int argc, char *argv[])
+{
+    if (argc != 1)
+    {
+        fprintf(stderr, "Usage: %s\n", argv[0]);
+        return EXIT_FAILURE;
+    }
+
+    if (__has_windows__)
+    {
+        printf("Running on Windows!\n");
+    }
+    else
+    {
+        printf("Running non-Windows!\n");
+    }
+    printf("Target architcture id: %d\n", __arch__);
+    printf("Target arch name: %s\n", __arch_name__);
+    printf("Pointer width: %d\n", __POINTER_WIDTH__);
+
+    return EXIT_SUCCESS;
+}