Skip to content

Commit

Permalink
Updating README for v0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Neko-Box-Coder committed Nov 3, 2024
1 parent 141b0a3 commit cce98c4
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
2 changes: 2 additions & 0 deletions Examples/test.cpp
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//bin/true;runcpp2 "$0" "$@"; exit;

/* runcpp2
PassScriptPath: true
Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

![runcpp2 logo](./Runcpp2Logo.png)

A cross-platform tool that can let you run any c++ files as a script, just like python!

Run c++ files anytime, anywhere.
A cross-platform declarative <s>and scriptable (WIP)</s> build system for c++ with the addition of letting you run any c++ files as a script, just like python!

### 🛠️ Prerequisites
- Any C++ compiler. The default user config only has g++ and msvc profiles. But feel free to
Expand Down Expand Up @@ -34,8 +32,7 @@ runcpp2 ./script.cpp <any arguments>
```

> [!NOTE]
> When invoking a c++ file with runcpp2, the first argument (`argv[0]`) to `main()` is the path
> to the script, not the path to an executable.
> On Unix, if you have added runcpp2 to your PATH and add this line `//bin/true;runcpp2 "$0" "$@"; exit;` to the top of your script, you can run the script directly by `./script.cpp <arguments>`
#### 2. Watch and give compile errors
If you want to edit the script but want to have feedback for any error, you can use "watch" mode.
Expand Down
4 changes: 3 additions & 1 deletion TODO.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
TODO:
- Track script info changes properly for either script change or dependency change
- Track include files for compiling
- Allow runcpp2 to be library
- Ability to compile runcpp2 as single cpp
Expand All @@ -12,6 +11,9 @@ TODO:
- Where the path contains escape character which escaped the wrapping quotes
- Use <csignal> to handle potential segfaults
- Separate git and local source options
- Add branch/tag option for git
- Add initialize submodule option for git
- Change "Default" to "DefaultProfile" and "DefaultPlatform"
- Migrate to libyaml
- Add wildcard support for filenames and extensions
- Add tests and examples (On Windows as well)
Expand Down

0 comments on commit cce98c4

Please sign in to comment.