From 3b0589a5455c951598bc17932a1b4c0c75327f78 Mon Sep 17 00:00:00 2001
From: isaak <isaak.buslovich@protonmail.ch>
Date: Sun, 2 Jun 2024 11:58:41 +0200
Subject: [PATCH] Readme updated

---
 README.md | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 82 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index cfe1ab4..b5bdfbe 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,82 @@
-# marketui
+# MarketMinds
+
+MarketMinds is a turn-based economic simulation game where players manage a company, make strategic decisions, and navigate various market events. The game involves crafting products, trading stocks, handling market events, and managing company morale and reputation.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Game Mechanics](#game-mechanics)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+- **Turn-based Gameplay**: Manage your company through a series of turns, making strategic decisions to maximize your company's value.
+- **Dynamic Market**: Prices of products fluctuate based on market trends, inflation, and other economic indicators.
+- **Crafting System**: Craft products using different recipes to add value to your company.
+- **Stock Trading**: Buy and sell stocks of various companies to optimize your portfolio.
+- **Random Events**: Encounter various random events that can impact your company's performance and strategy.
+- **Narrative Events**: Experience narrative-driven events that add depth to the gameplay.
+
+## Installation
+
+### Prerequisites
+
+- Python 3.7+
+- [Blessed](https://pypi.org/project/blessed/)
+- [PyYAML](https://pypi.org/project/PyYAML/)
+
+### Clone the Repository
+
+```sh
+git clone https://git.isaak.ovh/Isaak/marketui.git
+cd marketui
+```
+
+### Install Dependencies
+
+```sh
+pip install -r requirements.txt
+```
+
+## Usage
+
+To start the game, run the following command in your terminal:
+
+```sh
+python main.py
+```
+
+### Game Controls
+
+- **Arrow Keys**: Navigate through options.
+- **Enter**: Select an option.
+
+## Game Mechanics
+
+### Crafting Recipes
+
+The game includes various crafting recipes that convert raw materials into finished products. Each recipe has a specific input, output, and the number of turns required to complete.
+
+### Market Events
+
+The market undergoes random events that can affect product prices, company reputation, and other factors. Stay adaptive and plan your strategy accordingly.
+
+### Narrative Events
+
+Narrative events introduce scenarios that require player decisions. These decisions impact various aspects of the game such as employee morale, company budget, and reputation.
+
+### Economic Indicators
+
+The game tracks several economic indicators:
+- **Inflation Rate**: Adjusts the prices of products periodically.
+- **Unemployment Rate**: Influences market conditions and player decisions.
+- **GDP**: Reflects the overall economic health and impacts market trends.
+
+## File Descriptions
+
+- **main.py**: The main game script containing the game loop, player and AI logic, and market mechanics.
+- **narrative_scenes.yml**: YAML file containing narrative events and their conditions, effects, and descriptions.
+- **market_events.json**: JSON file containing market event definitions and probabilities.