Add example

Author: sagiegurari

CHANGELOG.md

@@ -1,5 +1,5 @@
 ## CHANGELOG
 
-### v0.1.0
+### v0.1.0 (2020-05-31)
 
 * Initial Release

CMakeLists.txt

@@ -53,6 +53,11 @@ if(NOT WIN32)
   set_target_properties(scriptexec PROPERTIES COMPILE_FLAGS "${X_CMAKE_C_FLAGS} -Wconversion")
 endif()
 
+# example
+add_executable(example examples/example.c)
+target_link_libraries(example scriptexec)
+set_target_properties(example PROPERTIES COMPILE_FLAGS "${X_CMAKE_C_FLAGS}")
+
 # tests
 enable_testing()
 

README.md

@@ -21,14 +21,13 @@ This library enables to invoke complex multi command scripts with a single C api
 
 ```c
 #include "scriptexec.h"
+#include <stdio.h>
 
 int main()
 {
   // invoke the script with default options
   struct ScriptExecResult result = scriptexec_run("echo 1\necho 2\necho 3\necho 4");
-  assert_num_equal(result.code, 0);
-  assert_string_equal(result.out, "1\n2\n3\n4\n");
-  assert_string_equal(result.err, "");
+  printf("Code: %d\nOutput:\n%s\nError:\n%s\n", result.code, result.out, result.err);
 
   // invoke the script with custom options
   struct ScriptExecOptions options = scriptexec_create_options();
@@ -38,10 +37,7 @@ int main()
   options.print_commands = true; // default false, if true will print every command before invocation
 
   result = scriptexec_run_with_options("echo 1\necho 2\necho 3\necho 4", options);
-
-  assert_num_equal(result.code, 0);
-  assert_string_equal(result.out, "1\n2\n3\n4\n");
-  assert_string_equal(result.err, "");
+  printf("Code: %d\nOutput:\n%s\nError:\n%s\n", result.code, result.out, result.err);
 }
 ```
 

examples/example.c

@@ -0,0 +1,19 @@
+#include "scriptexec.h"
+#include <stdio.h>
+
+int main()
+{
+  // invoke the script with default options
+  struct ScriptExecResult result = scriptexec_run("echo 1\necho 2\necho 3\necho 4");
+  printf("Code: %d\nOutput:\n%s\nError:\n%s\n", result.code, result.out, result.err);
+
+  // invoke the script with custom options
+  struct ScriptExecOptions options = scriptexec_create_options();
+  options.runner = "bash"; // default is 'sh'
+  options.working_directory = "./target"; // default to current working directory
+  options.exit_on_error = true; // default true, will break script execution on any error
+  options.print_commands = true; // default false, if true will print every command before invocation
+
+  result = scriptexec_run_with_options("echo 1\necho 2\necho 3\necho 4", options);
+  printf("Code: %d\nOutput:\n%s\nError:\n%s\n", result.code, result.out, result.err);
+}