update README; and environment.yaml

This commit is contained in:
2025-03-30 05:01:21 -05:00
parent 881949e653
commit 2ccf647137
4 changed files with 255 additions and 48 deletions

View File

@@ -1,3 +1,36 @@
# Evil nKode
Simulated nKode Cracker
Simulated nKode Cracker
## Installation
- Python version 3.10 or greater is required
- Install conda (or your preferred tool) for environment management
### Using conda
```bash
conda env create -f environment.yml
conda activate pynkode
```
## Starting a Jupyter Notebook
### Option 1: Using classic Jupyter Notebook
```bash
# Ensure your environment is activated
# For conda: conda activate pynkode
# For pyenv: (should be automatic if in the directory)
# Start the Jupyter Notebook server
jupyter notebook
```
### Option 2: Using JupyterLab
```bash
# Ensure your environment is activated
# Start JupyterLab
jupyter lab
```
## Notebooks
- [evilnkode](notebooks/evilkode.ipynb)