Skip to content

Commit

Permalink
Add docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
FiveMovesAhead committed May 6, 2024
1 parent ca66baf commit 5e5ea15
Show file tree
Hide file tree
Showing 12 changed files with 90 additions and 0 deletions.
69 changes: 69 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# The Innovation Game

This repository contains the implementation of The Innovation Game (TIG).

## Important Links

* [TIG's tech explainer](docs/1_basics.md)
* [Getting started with Innovating](tig-algorithms/README.md)
* [Getting started with Benchmarking](tig-benchmarker/README.md)
* [Challenge descriptions](tig-challenges/docs/knapsack.md)

## Repo Contents
### tig-algorithms

A Rust crate that hosts algorithm submissions made by Innovators in TIG.

Submissions are committed to their own branch with name:

`<challenge_name>\<algorithm_name>`

Submissions only get merged to the main branch after earning sufficient merge points.

WASM blobs for an algorithm are stored in the `wasm` subfolder and can be downloaded via:

`https://raw.githubusercontent.com/tig-foundation/tig-monorepo/<branch_name>/tig-algorithms/wasm/<branch_name>.wasm`

### tig-api

A Rust crate for making requests to TIG's API.

Developers must either enable feature `request` (uses `reqwest`) or `request-js` (uses `web-sys`)

### tig-benchmarker

A Rust crate that implements a Benchmarker for TIG that can run in the browser.

### tig-challenges

A Rust crate that contains the implementation of TIG's challenges (computational problems adapted for proof-of-work).

### tig-protocol

A Rust crate that contains the implementation of TIG's core protocol logic.

### tig-structs

A Rust crate that contains the definitions of structs used throughout TIG.

### tig-token

Solidity contract for TIG's ERC20 token that is deployed on Ethereum L2 Base chain.

### tig-utils

A Rust crate that contains utility functions used throughout TIG.

### tig-wasm

A Rust crate for wrapping algorithm submissions for compilation into WASM with an exported `entry_point`.

### tig-worker

A Rust crate for verifying and computing solutions.

Solutions are computed by executing an algorithm in a WASM virtual machine ([TIG's fork of wasmi](https://github.com/tig-foundation/wasmi)).

## License

Placeholder
1 change: 1 addition & 0 deletions docs/1_basics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder
1 change: 1 addition & 0 deletions docs/2_challenges.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder
1 change: 1 addition & 0 deletions docs/3_innovators.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder
1 change: 1 addition & 0 deletions docs/4_benchmarkers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder
1 change: 1 addition & 0 deletions docs/5_opow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder
1 change: 1 addition & 0 deletions docs/6_q_and_a.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder
3 changes: 3 additions & 0 deletions tig-algorithms/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Getting Started with Innovating

Placeholder
3 changes: 3 additions & 0 deletions tig-benchmarker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Getting Started with Benchmarking

Placeholder
3 changes: 3 additions & 0 deletions tig-challenges/docs/knapsack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Knapsack Problem

Description placeholder
3 changes: 3 additions & 0 deletions tig-challenges/docs/satisfiability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Boolean Satisfiability

Description placeholder
3 changes: 3 additions & 0 deletions tig-challenges/docs/vehicle_routing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Vehicle Routing

Description placeholder

0 comments on commit 5e5ea15

Please sign in to comment.