diff --git a/README.md b/README.md new file mode 100644 index 00000000..f4faf76b --- /dev/null +++ b/README.md @@ -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: + +`\` + +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//tig-algorithms/wasm/.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 \ No newline at end of file diff --git a/docs/1_basics.md b/docs/1_basics.md new file mode 100644 index 00000000..b3a42524 --- /dev/null +++ b/docs/1_basics.md @@ -0,0 +1 @@ +placeholder \ No newline at end of file diff --git a/docs/2_challenges.md b/docs/2_challenges.md new file mode 100644 index 00000000..b3a42524 --- /dev/null +++ b/docs/2_challenges.md @@ -0,0 +1 @@ +placeholder \ No newline at end of file diff --git a/docs/3_innovators.md b/docs/3_innovators.md new file mode 100644 index 00000000..b3a42524 --- /dev/null +++ b/docs/3_innovators.md @@ -0,0 +1 @@ +placeholder \ No newline at end of file diff --git a/docs/4_benchmarkers.md b/docs/4_benchmarkers.md new file mode 100644 index 00000000..b3a42524 --- /dev/null +++ b/docs/4_benchmarkers.md @@ -0,0 +1 @@ +placeholder \ No newline at end of file diff --git a/docs/5_opow.md b/docs/5_opow.md new file mode 100644 index 00000000..b3a42524 --- /dev/null +++ b/docs/5_opow.md @@ -0,0 +1 @@ +placeholder \ No newline at end of file diff --git a/docs/6_q_and_a.md b/docs/6_q_and_a.md new file mode 100644 index 00000000..b3a42524 --- /dev/null +++ b/docs/6_q_and_a.md @@ -0,0 +1 @@ +placeholder \ No newline at end of file diff --git a/tig-algorithms/README.md b/tig-algorithms/README.md new file mode 100644 index 00000000..09f1668e --- /dev/null +++ b/tig-algorithms/README.md @@ -0,0 +1,3 @@ +# Getting Started with Innovating + +Placeholder \ No newline at end of file diff --git a/tig-benchmarker/README.md b/tig-benchmarker/README.md new file mode 100644 index 00000000..e79df0a0 --- /dev/null +++ b/tig-benchmarker/README.md @@ -0,0 +1,3 @@ +# Getting Started with Benchmarking + +Placeholder \ No newline at end of file diff --git a/tig-challenges/docs/knapsack.md b/tig-challenges/docs/knapsack.md new file mode 100644 index 00000000..b1e3567d --- /dev/null +++ b/tig-challenges/docs/knapsack.md @@ -0,0 +1,3 @@ +# Knapsack Problem + +Description placeholder \ No newline at end of file diff --git a/tig-challenges/docs/satisfiability.md b/tig-challenges/docs/satisfiability.md new file mode 100644 index 00000000..03616006 --- /dev/null +++ b/tig-challenges/docs/satisfiability.md @@ -0,0 +1,3 @@ +# Boolean Satisfiability + +Description placeholder \ No newline at end of file diff --git a/tig-challenges/docs/vehicle_routing.md b/tig-challenges/docs/vehicle_routing.md new file mode 100644 index 00000000..64db3042 --- /dev/null +++ b/tig-challenges/docs/vehicle_routing.md @@ -0,0 +1,3 @@ +# Vehicle Routing + +Description placeholder \ No newline at end of file