Merge pull request #30 from leonvanbokhorst/Refactor-project-structure-and-update-README.md

Refactor project structure and update README.md

Author: leonvanbokhorst

README.md

@@ -1,7 +1,7 @@
-[![CI](https://github.com/leonvanbokhorst/ActiveInferenceForager/actions/workflows/ci.yml/badge.svg)](https://github.com/leonvanbokhorst/ActiveInferenceForager/actions/workflows/ci.yml)
-
 # ActiveInferenceForager
 
+[![CI](https://github.com/leonvanbokhorst/ActiveInferenceForager/actions/workflows/ci.yml/badge.svg)](https://github.com/leonvanbokhorst/ActiveInferenceForager/actions/workflows/ci.yml)
+
 Current iteration of the Active Inference Forager project as of 2021-10-14.
 
 This project aims to implement an intelligent chat agent using principles from Active Inference, a neuroscientific theory of brain function and decision-making. We've chosen to enhance our existing Deep Q-Network (DQN) agent with elements of Active Inference, specifically focusing on free energy minimization.

project_structure.md

@@ -1,6 +1,7 @@
 # Project Structure for ActiveInferenceForager
 
 ## Root Directory
+
 - `.gitignore`: Specifies files and directories that should be ignored by Git.
 - `dqn_fep_agent.pth` and `dqn_fep_model.pth`: Likely model files for a deep Q-network (DQN) with free energy principle (FEP) agent.
 - `pytest.ini`: Configuration file for pytest, a testing framework.
@@ -10,15 +11,18 @@
 - `setup.py`: A script for installing the package, typically used with Python projects.
 
 ## config/
+
 - `default_config.yaml`: A YAML configuration file containing default settings for the project.
 
 ## docs/
+
 - `branch-protection-info.md`: Documentation related to branch protection.
 - `project-task-breakdown.md`: A document detailing the breakdown of project tasks.
 - `project-vision-markdown.md`: A document outlining the project's vision.
 - `README.md`: Additional documentation for the project.
 
 ## src/
+
 - `active_inference_forager/`: Main source directory for the project.
   - `main.py`: The main entry point for the application.
   - `agents/`: Contains agent-related code.
@@ -36,6 +40,7 @@
   - `active_inference_forager.egg-info/`: Metadata directory for the Python package.
 
 ## tests/
+
 - `__init__.py`: Initializes the tests module.
 - `integration/`: Contains integration tests.
   - `__init__.py`: Initializes the integration tests module.