pieeg-club / EEGwithRaspberryPI

Not supported. Measure 8 EEG channels with Shield PiEEG and RaspberryPi in C library
863 stars 87 forks source link

Update README.md #8

Closed 444B closed 6 months ago

444B commented 6 months ago

Overview

This PR introduces several updates to the README.md to improve clarity, enhance the presentation of information, and make the documentation more accessible to potential users and contributors. Key updates include reformatting sections for better readability, updating URLs, and refining the language to be more precise about the non-medical nature of the project.

Key Changes

Purpose

The goal of these updates is to ensure the README serves as a comprehensive and clear guide for anyone interested in exploring the neuroscience world through Raspberry Pi. By making these changes, we aim to foster a more informed and engaged community around the PiEEG project.

Request for Review

I invite all contributors and interested parties to review these changes to ensure they accurately reflect the project's aims and are in line with the community standards. Your feedback is invaluable to making this documentation as helpful and accurate as possible.

Thank you for your contributions and support in advancing the field of neuroscience accessibility.

444B commented 6 months ago

@Ildaron please kindly review the changes. I think the new CAUTION and WARNING sections are especially useful in making the purpose of this project clear. I am happy to work with you on managing the Github project if that is something you need

Ildaron commented 6 months ago

Hi @444B thank you so much, looks great!