Skip to content

Commit

Permalink
doc: add readme
Browse files Browse the repository at this point in the history
Signed-off-by: Tony Gorez <[email protected]>
  • Loading branch information
tony-go committed Feb 23, 2024
1 parent 828185b commit a8251d6
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 3 deletions.
3 changes: 0 additions & 3 deletions Brewfile
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
brew "cmake"
brew "clang-format"
brew "doxygen"
brew "v8"
50 changes: 50 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<h1 align="center">small</h1>
<h3 align="center">Toy runtime build on top of <a src="https://github.com/crossnx/includejs">includejs</a></h3>
<p align="center">
<a href="https://github.com/crossnx/small/actions/workflows/ci.yml"><img src="https://github.com/crossnx/small/actions/workflows/ci.yml/badge.svg" alt="github action build"></a>
</p>

## Usage

```
./build/small_runtime <path of your .fs file>
```

Example:

```
./build/small_runtime index.js
```

## Dependencies

- C++
- CMake
- JavascriptCore
- Brew (macOS)

## Build localy

### Install dependencies

- For `macOS`
```
brew bundle
```

- For Ubuntu
```
sudo apt-get install --yes libjavascriptcoregtk-4.0-dev
```

### Run

```
make
```

When the build is finished, you'll find the executable available:

```
./build/small_runtime
```

0 comments on commit a8251d6

Please sign in to comment.