Change readme to something more simple

yjmantilla / sovabids

A python package for the automatic conversion of EEG datasets to the BIDS standard, with a focus on making the most out of metadata.

https://sovabids.readthedocs.io/en/latest/

BSD 3-Clause "New" or "Revised" License

9 stars 3 forks source link

Change readme to something more simple #19

Closed yjmantilla closed 3 years ago

yjmantilla commented 3 years ago

So the readme is basically the gsoc proposal, it is quite verbose. We should do a more readable readme with maybe some basic usage.

Also leave the gsoc to another file (proposal.md)? It would be nice to keep it as history and as an initial blueprint of the project.

civier commented 3 years ago

Sure. Although I don't know if it's a priority at the moment. Do you know of people that accessing the project actively? I wonder if that would be the case before we make it public more widely.

yjmantilla commented 3 years ago

Not really, just the people I have mentioned the project to.

At most 14 people has accessed this repo hehe

aswinnarayanan commented 3 years ago

@yjmantilla For now, sounds like a good idea to move the GSOC proposal onto its own about.md and update the README.md with the basic instructions and also link to the about page.

yjmantilla commented 3 years ago

Closing this as it is done.