From 53862f0ab9b92dddb1dfb17db8c532c752c019b2 Mon Sep 17 00:00:00 2001 From: skundu42 Date: Tue, 28 Jan 2025 17:53:51 +0530 Subject: [PATCH] dependencies and prediction markets --- docs/dependencies.md | 149 ++++++++++++++++++++++++++++++++++++++ docs/install.md | 1 + docs/predictionmarkets.md | 3 +- mkdocs.yml | 8 +- 4 files changed, 158 insertions(+), 3 deletions(-) create mode 100644 docs/dependencies.md create mode 100644 docs/install.md diff --git a/docs/dependencies.md b/docs/dependencies.md new file mode 100644 index 00000000..3be5bc41 --- /dev/null +++ b/docs/dependencies.md @@ -0,0 +1,149 @@ +# Install Dependencies + +Before getting started, ensure you have the following tools installed: + +- **Python >= 3.10** +- **Poetry** (for dependency management) +- **Git** (for version control) +- **GCP CLI** (optional, for deploying and monitoring agents) + + +## Installation Steps + +### **1. Install Python >= 3.10** + +#### **Check Python Version:** +```bash +python3 --version +``` + +#### **Install Python:** + +- **On Ubuntu/Debian:** + ```bash + sudo apt update + sudo apt install -y software-properties-common + sudo add-apt-repository ppa:deadsnakes/ppa + sudo apt update + sudo apt install -y python3.10 python3.10-venv python3.10-dev + ``` + +- **On macOS (with Homebrew):** + ```bash + brew install python@3.10 + ``` + +- **On Windows:** + 1. Download Python from the [official Python website](https://www.python.org/downloads/). + 2. Run the installer and ensure "Add Python to PATH" is checked. + +#### **Verify Installation:** +```bash +python3 --version +``` + +--- + +### **2. Install Poetry (Dependency Management)** + +#### **Check if Poetry is Already Installed:** +```bash +poetry --version +``` + +#### **Install Poetry:** +- Run the following command: + ```bash + curl -sSL https://install.python-poetry.org | python3 - + ``` + +#### **Add Poetry to PATH (if not already added):** +- **Linux/macOS:** + ```bash + export PATH="$HOME/.local/bin:$PATH" + ``` + Add the above line to your shell configuration file (`~/.bashrc`, `~/.zshrc`, or similar). + +- **Windows:** + Poetry is added to PATH during installation, but you may need to restart your terminal. + +#### **Verify Installation:** +```bash +poetry --version +``` + +--- + +### **3. Install Git (Version Control)** + +#### **Check if Git is Already Installed:** +```bash +git --version +``` + +#### **Install Git:** +- **On Ubuntu/Debian:** + ```bash + sudo apt update + sudo apt install -y git + ``` + +- **On macOS (with Homebrew):** + ```bash + brew install git + ``` + +- **On Windows:** + 1. Download Git from the [official Git website](https://git-scm.com/). + 2. Run the installer and follow the setup wizard. + +#### **Verify Installation:** +```bash +git --version +``` + +--- + +### **4. Install GCP CLI (Google Cloud CLI)** *(Optional)* + +#### **Check if GCP CLI is Already Installed:** +```bash +gcloud --version +``` + +#### **Install GCP CLI:** + +- **On Ubuntu/Debian:** + ```bash + sudo apt update + sudo apt install -y apt-transport-https ca-certificates gnupg + echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list + sudo apt install -y google-cloud-sdk + ``` + +- **On macOS (with Homebrew):** + ```bash + brew install --cask google-cloud-sdk + ``` + +- **On Windows:** + 1. Download the installer from the [GCP CLI website](https://cloud.google.com/sdk/docs/install). + 2. Run the installer and follow the setup wizard. + +#### **Initialize GCP CLI:** +After installation, run the following to set up the CLI: +```bash +gcloud init +``` + +#### **Verify Installation:** +```bash +gcloud --version +``` + +--- + +By completing these steps, you'll have Python, Poetry, Git, and optionally GCP CLI installed and ready to use. + + + diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 00000000..648db68c --- /dev/null +++ b/docs/install.md @@ -0,0 +1 @@ +# Install and Run \ No newline at end of file diff --git a/docs/predictionmarkets.md b/docs/predictionmarkets.md index e25c4380..b53127e3 100644 --- a/docs/predictionmarkets.md +++ b/docs/predictionmarkets.md @@ -2,7 +2,7 @@ Prediction markets are decentralized platforms that allow participants to speculate on the outcomes of future events by trading tokens or assets tied to specific events. It leverages blockchain technology and smart contracts to create transparent, trustless, and immutable environments for this type of speculation. -![](/docs/images/predictionmarket.png) +![predictionmarket](/docs/images/predictionmarket.png) ## Key Components of Prediction Markets in Web3 - Event-Based Contracts: @@ -39,3 +39,4 @@ Anyone with internet access and a Web3 wallet can participate, removing geograph - Accurate Market Sentiment: Prediction markets often provide a more accurate reflection of the probability of events because participants have financial incentives to base their trades on real information or beliefs. + diff --git a/mkdocs.yml b/mkdocs.yml index 0f0fbe52..286aa9e2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,11 @@ site_name: Prediction Market Agent Tooling nav: - Home: index.md + - Prediction Markets: predictionmarkets.md + - Quickstart + - Dependencies: dependencies.md + - Install and Configure: install.md - Contributing: contributing.md -theme: - name: material +theme: + name: material \ No newline at end of file