Merge pull request #8 from TaskBeacon/codex/explain-codebase-structure-to-newcomer

Improve READMEs

Author: zh1peng

README.md

@@ -1,6 +1,26 @@
 # psyflow
 
-This repository hosts the **psyflow** package.
+**psyflow** is a small framework that helps build modular cognitive and
+behavioural experiments on top of
+[PsychoPy](https://www.psychopy.org/).  It bundles a collection of helper
+classes and utilities so you can focus on experimental logic rather than
+boilerplate.
+
+## Key components
+
+- **BlockUnit** – manage blocks of trials and collect results
+- **StimUnit** – present a single trial and log responses
+- **StimBank** – register and build stimuli from Python functions or YAML
+  definitions
+- **SubInfo** – gather participant information via a simple GUI
+- **TaskSettings** – central configuration object for an experiment
+- **TriggerSender** – send triggers to external devices (e.g. EEG/MEG)
+
+The package also provides a command line tool `psyflow-init` which
+scaffolds a new project using the bundled cookiecutter template.
+
+Comprehensive documentation and tutorials are available on the
+[GitHub Pages site](https://taskbeacon.github.io/psyflow/).
 
 ## Publishing to PyPI
 

psyflow/templates/cookiecutter-psyflow/{{cookiecutter.project_name}}/README.md

@@ -0,0 +1,10 @@
+This project was generated with **psyflow-init**.
+
+## Usage
+
+1. Edit the configuration files under `config/` to define your
+   stimuli, trigger codes and general task settings.
+2. Run `python main.py` to launch the experiment.
+
+For full documentation on psyflow and how to customise this template,
+visit the [GitHub Pages site](https://taskbeacon.github.io/psyflow/).