Rework the readme a bit (#680)

Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

Author: hoechenberger

.circleci/config.yml

@@ -1132,13 +1132,9 @@ jobs:
       - store_artifacts:
           path: docs/site
           destination: site
-      - persist_to_workspace: # For documentation deployment to gh-pages
-          root: ~/
-          paths: project/docs/site
 
   deploy_docs:
-    docker:
-      - image: node:10
+    <<: *imageconfig
     steps:
       - add_ssh_keys:
           fingerprints:
@@ -1157,15 +1153,23 @@ jobs:
           <<: *git
       - run:
           <<: *bashenv
+      - run:
+          # This is a bit computationally inefficient, but it should be much
+          # faster to "cp" directly on the machine rather than persist
+          # 1GB doc build to workspace then go retrieve it
+          name: Build documentation again
+          command: |
+            make doc
       - run:
           name: Deploy docs to gh-pages branch
           # https://github.com/jimporter/mike
           command: |
-            git config --global user.email "circle@mne.com"
-            git config --global user.name "Circle CI"
             # Arguments used in all mike commands
             ARGS="--config-file docs/mkdocs.yml"
-            echo "Deploying dev"
+            # First we need to actually check out our current version of
+            # gh-pages so we don't remove it!
+            git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*"
+            git fetch origin
             # If it's tagged as v*, deploy as "v*" and "stable" as well
             if git describe --tags --exact-match $(git rev-parse HEAD); then
               VERSION="$(git describe --tags --exact-match $(git rev-parse HEAD))"
@@ -1184,7 +1188,7 @@ jobs:
             fi
             git checkout gh-pages
             git reset $(git commit-tree HEAD^{tree} -m "Deploy and squash docs [ci skip]")
-            git log -n1
+            git log -n3  # should just be one, but let's be sure
             git push origin --force gh-pages
 
 

README.md

@@ -1,19 +1,27 @@
-[![CircleCI](https://circleci.com/gh/mne-tools/mne-bids-pipeline.svg?style=svg)](https://circleci.com/gh/mne-tools/mne-bids-pipeline)
+# <img src="https://raw.github.com/mne-tools/mne-bids-pipeline/main/docs/source/assets/mne.svg" alt="MNE Logo" height="20"> The MNE-BIDS-Pipeline
 
-# MNE-BIDS-Pipeline
+**The MNE-BIDS-Pipeline is a full-flegded processing pipeline for your MEG and
+EEG data.** It operates on data stored according to the [Brain Imaging Data
+Structure (BIDS)](https://bids.neuroimaging.io/). Under the hood, it uses [MNE-Python](https://mne.tools).
 
-The MNE-BIDS-Pipeline is a full-flegded processing pipeline for your MEG and
-EEG data. It operates on data stored according to the Brain Imaging Data
-Structure (BIDS).
+## 💡 Basic concepts and features
 
-# Documentation
+* 🐾 Data processing as a sequence of processing steps.
+* ⏏ Your data can be "ejected" from the pipeline at **any** stage. No lock-in!
+* 🧾 Extensive processing and analysis summary reports.
+* 🎬 Process just a single participant, or as many as several hundreds of participants – in parallel.
+* 🛠 Configuration via a simple text file.
+* 💻 Execution via an easy-to-use command-line utility.
+* 🆘 Helpful error messages in case something goes wrong.
 
-Please find the installation and usage instructions at
-[mne.tools/mne-bids-pipeline](https://mne.tools/mne-bids-pipeline).
+## 📘 Installation and usage instructions
 
-# Acknowledgments
+Please find the documentation at
+[**mne.tools/mne-bids-pipeline**](https://mne.tools/mne-bids-pipeline).
 
-The original pipeline for MEG/EEG data processing with MNE python was built
+## ❤ Acknowledgments
+
+The original pipeline for MEG/EEG data processing with MNE-Python was built
 jointly by the [Cognition and Brain Dynamics Team](https://brainthemind.com/)
 and the [MNE Python Team](https://mne.tools), based on scripts originally
 developed for this publication:

docs/source/features/gen_steps.py

@@ -12,6 +12,7 @@
 Template. All steps exist in the `steps`/ directory.
 """
 
+print('Generating steps …')
 step_modules = _get_step_modules()
 
 # Construct the lines of steps.md