Updated README and TODO, added build scripts, fixed run path and CMake

Author: Neko-Box-Coder

Build.bat

@@ -0,0 +1,21 @@
+@REM @echo off
+
+setlocal
+
+mkdir Build || goto :error
+
+pushd Build || goto :error
+
+cmake .. || goto :error
+cmake --build . --target Embed2C || goto :error
+cmake .. || goto :error
+cmake --build . -j 16 || goto :error
+
+popd
+
+goto :eof
+
+:error
+echo Error occurred during the build process.
+
+goto :eof

Build.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+set -e
+
+mkdir -p ./Build
+pushd ./Build
+cmake ..
+cmake --build . --target Embed2C
+cmake ..
+cmake --build . -j 16
+
+popd
+

CMakeLists.txt

@@ -26,22 +26,28 @@ else()
     file(SIZE "${CMAKE_CURRENT_LIST_DIR}/Src/runcpp2/DefaultYAMLs.c" EMBEDDED_FILE_SIZE)
 endif()
 
+add_subdirectory("${CMAKE_CURRENT_LIST_DIR}/External/Embed2C")
+
 if(RUNCPP2_UPDATE_DEFAULT_YAMLS OR EMBEDDED_FILE_SIZE LESS 1024)
-    add_subdirectory("${CMAKE_CURRENT_LIST_DIR}/External/Embed2C")
     include("${CMAKE_CURRENT_LIST_DIR}/External/Embed2C/embedFile.cmake")
 
     set(EMBED_EXEC_PATH "")
     GET_EXEC_PATH(EMBED_EXEC_PATH)
 
-    set(FILES_TO_EMBED "${CMAKE_CURRENT_LIST_DIR}/DefaultYAMLs/DefaultCompilerProfiles.yaml"
-                        "DefaultCompilerProfiles"
-                        "${CMAKE_CURRENT_LIST_DIR}/DefaultYAMLs/DefaultScriptInfo.yaml"
-                        "DefaultScriptInfo"
-                        )
-
-    EMBED_FILES("${EMBED_EXEC_PATH}"
-                "${CMAKE_CURRENT_LIST_DIR}/Src/runcpp2/DefaultYAMLs.c"
-                "${FILES_TO_EMBED}")
+    if("${EMBED_EXEC_PATH}" STREQUAL "")
+        message(WARNING "Please build Embed2C first")
+        return()
+    else()
+        set(FILES_TO_EMBED "${CMAKE_CURRENT_LIST_DIR}/DefaultYAMLs/DefaultCompilerProfiles.yaml"
+                            "DefaultCompilerProfiles"
+                            "${CMAKE_CURRENT_LIST_DIR}/DefaultYAMLs/DefaultScriptInfo.yaml"
+                            "DefaultScriptInfo"
+                            )
+
+        EMBED_FILES("${EMBED_EXEC_PATH}"
+                    "${CMAKE_CURRENT_LIST_DIR}/Src/runcpp2/DefaultYAMLs.c"
+                    "${FILES_TO_EMBED}")
+    endif()
 endif()
 
 

README.md

@@ -1,19 +1,121 @@
 ## 🏃‍♂️ runcpp2
-
 A cross-platform tool that can let you run any c++ file as a script, just like python!
 
 Run c++ files anytime, anywhere.
 
 ### Prerequisites
+- A C++ compiler, currently only tested with g++
 
-TODO
+TODO: Support for other compilers
 
 ### Installation
+1. Clone the repository with `git clone --recursive https://github.com/Neko-Box-Coder/runcpp2.git`
+2. Run `Build.sh` or `Build.bat` to build
 
-TODO
-
+TODO: Ability to use pre-built binary
 
 ### How to use
 
-TODO
+#### Single C/C++ File
+Just run `runcpp2 <filename>.cpp <arguments...>` and it will execute the file just like any other script.
+
+#### C/C++ File with External Libraries
+
+TODO: Detail documentations
+
+<details>
+<summary>Sample C++ file</summary>
+
+```c++
+
+/* runcpp2
+
+OverrideCompileFlags:
+    # Profile with the respective flags to override
+    "g++":
+        # Flags to be removed from the default compile flags, separated by space
+        # Remove: "-Werror"
+
+Dependencies:
+-   Name: ssLogger
+    Platforms: [Windows, Linux, MacOS]
+    Source:
+        Type: Git
+        Value: "https://github.com/Neko-Box-Coder/ssLogger.git"
+    LibraryType: Static
+    # LibraryType: Header
+    IncludePaths:
+        - "Include"
+    
+    # (Optional if LibraryType is Header) Link properties of the dependency
+    LinkProperties:
+        # Properties for searching the library binary for the profile
+        "g++":
+            # The library names to be searched for when linking against the script
+            SearchLibraryNames: ["ssLogger"]
+            
+            # (Optional) The library names to be excluded from being searched
+            ExcludeLibraryNames: ["ssLogger_SRC"]
+            
+            # The path (relative to the dependency folder) to be searched for the dependency binaries
+            SearchDirectories: ["./build"]
+            
+            # (Optional) Additional link options for this dependency
+            AdditionalLinkOptions: 
+                All: []
+
+    
+    # (Optional) List of setup commands for the supported platforms
+    Setup:
+        # Setup commands for the specified platform
+        All:
+            # Setup commands for the specified profile. 
+            # All commands are run in the dependency folder
+            "g++":
+            -   "git submodule update --init --recursive"
+            -   "mkdir build"
+            -   "cd build && cmake .."
+            -   "cd build && cmake --build . -j 16"
+*/
+
+
+
+#include "ssLogger/ssLogSwitches.hpp"
+
+#define ssLOG_USE_SOURCE 1
+#if !ssLOG_USE_SOURCE
+    #include "ssLogger/ssLogInit.hpp"
+#endif
+ 
+#include "ssLogger/ssLog.hpp"
+
+#include <iostream>
+
+int main(int argc, char* argv[])
+{
+    std::cout << "Hello World" << std::endl;
+    
+    for(int i = 0; i < argc; ++i)
+        std::cout << "Arg" << i << ": " << argv[i] << std::endl;
+    
+    #if ssLOG_USE_SOURCE
+        ssLOG_LINE("Source dependency is working!!!");
+    #else
+        ssLOG_LINE("Header only dependency is working!!!");
+    #endif
+
+    int CheckCounter = 5;
+    ssLOG_FATAL("Test fatal: " << CheckCounter);
+    ssLOG_ERROR("Test error: " << CheckCounter);
+    ssLOG_WARNING("Test warning: " << CheckCounter);
+    ssLOG_INFO("Test info: " << CheckCounter);
+    ssLOG_DEBUG("Test debug: " << CheckCounter);
+    
+    return 0;
+}
+
+```
+
+
+</details>
 

Src/runcpp2/runcpp2.cpp

@@ -43,8 +43,7 @@ namespace
     {
         std::error_code _;
 
-        std::string runCommand = runcpp2::ProcessPath(  "cd " + scriptDirectory + 
-                                                        " && ./" + scriptName + exeExt);
+        std::string runCommand = runcpp2::ProcessPath(scriptDirectory + "/" + scriptName + exeExt);
 
         if(!runArgs.empty())
         {
@@ -287,6 +286,8 @@ bool runcpp2::RunScript(const std::string& scriptPath,
         std::error_code copyErrorCode;
         ghc::filesystem::copy(exeToCopy, scriptDirectory + "/" + scriptName + exeExt, _);
 
+        //TODO: Copy shared library files as well
+        
         if(copyErrorCode)
         {
             ssLOG_ERROR("Failed to copy file from " << exeToCopy << " to " << scriptDirectory);

TODO.md

@@ -1,3 +1,4 @@
 - Allow script info as standalone yaml file
+- Copy shared libraries to be next to the executable
 - Commandline options
 - Allow Languages to override FileExtensions in compiler profile