updated readme

Author: shashkat

README.md

@@ -7,10 +7,11 @@ A custom, lightweight implementation of a Slither-like environment designed spec
 This repository provides a sandbox environment where a snake agent must navigate a field, consume food to grow, and avoid colliding with other snakes. It is built to be highly configurable, supporting both rendered play for visualization and "headless" modes for accelerated RL training.
 
 ## Project structure
-- `src/`: The engine of the game. Contains the core logic (`game.py`) and helper functions (`utils.py`).
+- `src/slithbot`: The engine of the game. Contains the core logic (`game.py`), helper functions (`utils.py`), and entrypoint code (`main.py`).
 - `config/`: YAML files to easily tweak game parameters like world size, snake count, and rendering options.
-- `scripts/`: Entry points to execute the environment.
-- `requirements.txt`: Python dependencies needed to get up and running.
+- `tests/`: Testing code for the various functions in the project.
+- `pyproject.toml`: Configuration file for appropriate installation. Just run `pip install .` to install.
+- `docs/`: Some images etc. used in the project.
 
 ## Getting started
 
@@ -22,20 +23,16 @@ git clone https://github.com/shashkat/slithbot.git
 cd slithbot
 conda create -n slithbot_env python=3.12
 conda activate slithbot_env
-pip install -r requirements.txt
+pip install . # for editable install, use: pip install -e .
 ```
 
 ### Running the game
 
-To see the environment in action using the default configuration, run:
+To see the environment in action using the default configuration, run from the cloned repo's root location:
 
-`python scripts/run_game.py`
+`slithbot-run config/base.yaml`
 
-### Configuration
-
-You can swap out configurations to change how the environment behaves. For example, to run without rendering (ideal for training):
-
-`python scripts/run_game.py config/no_render.yaml`
+Similarly, you can execute with other configurations. See the base configurations present in `slithbot/config`. Feel free to create your own configurations.
 
 ## Gameplay demo