From 378f5d38a75cbc2a6aaa553c9b34fbf9fd15dce7 Mon Sep 17 00:00:00 2001
From: Florian Sylvain <sylvainflorian@proton.me>
Date: Fri, 28 Mar 2025 00:54:49 +0100
Subject: [PATCH] feat: initial readme

---
 README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3c96310
--- /dev/null
+++ b/README.md
@@ -0,0 +1,88 @@
+# FDJ SLAYER
+
+A Python application that generates random EuroMillions lottery draws using multiple entropy sources to maximize randomness.
+
+## Description
+
+This project aims to create truly random EuroMillions lottery draws by combining various entropy sources including hardware information, weather data, system metrics, and cryptographic functions. It generates a configurable number of draws and allows users to view them.
+
+## Features
+
+- Multiple entropy sources for good randomness:
+  - Weather data from [OpenMeteo API](https://open-meteo.com/)
+  - Hardware and system information
+  - OS random data and cryptographic functions
+  - CPU/memory usage and other dynamic metrics
+- Configurable number of lottery draws
+- Progress bar visualization during draw generation (yes, it's a huge feature :p)
+
+## Installation
+
+1. Clone the repository:
+```bash
+git clone https://github.com/Floriansylvain/FDJ-SLAYER.git
+cd FDJ-SLAYER
+```
+
+2. Install dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+## Usage
+
+Run the main script to generate lottery draws:
+```bash
+python src/main.py
+```
+
+The program will:
+
+1. Generate the configured number of random draws
+2. Display a randomly selected draw as the final result
+3. Allow you to view additional draws on request
+
+## How It Works
+
+The application uses a combination of entropy sources to generate truly random lottery draws:
+
+1. **Static Entropy Sources**:
+   - OS random data
+   - Hardware identifiers
+   - System configuration
+   - Weather data from geographically random locations
+
+2. **Dynamic Entropy Sources**:
+   - Current timestamp
+   - CPU and memory usage
+   - Process and thread information
+   - Network statistics
+
+All sources are combined, hashed, and processed to create seeds for the random number generator that selects the lottery numbers.
+
+## Configuration
+
+Edit the constants in ``scr/constants.py`` to modify:
+
+| Parameter              | Description                                           |
+|------------------------|-------------------------------------------------------|
+| `NUMBER_OF_DRAWS`      | Number of draws to generate                           |
+| `NUMBER_OF_NUMBERS`    | Number of main numbers in a draw (5 for EuroMillions) |
+| `MAX_NUMBER`           | Maximum main number value (50 for EuroMillions)       |
+| `NUMBER_OF_STARS`      | Number of star numbers in a draw (2 for EuroMillions) |
+| `MAX_STAR`             | Maximum star number value (12 for EuroMillions)       |
+| Weather API parameters | Configuration for the OpenMeteo API                   |
+
+## Dependencies
+
+| Package                                                            | Purpose                          |
+|--------------------------------------------------------------------|----------------------------------|
+| [openmeteo_requests](https://pypi.org/project/openmeteo-requests/) | Weather data retrieval           |
+| [progress](https://pypi.org/project/progress/)                     | Progress bar visualization       |
+| [psutil](https://pypi.org/project/psutil/)                         | System metrics collection        |
+| [requests-cache](https://pypi.org/project/requests-cache/)         | Caching API requests             |
+| [numpy](https://pypi.org/project/numpy/)                           | `ValuesAsNumpy()` on API results |
+Markdown Table Formatter
+## License
+
+TODO: Add a license