search

DynamicsAndNeuralSystems / pyspi

Comparative analysis of pairwise interactions in multivariate time series.
https://time-series-features.gitbook.io/pyspi/
GNU General Public License v3.0
198 stars 26 forks source link

Update pyspi README #54

Closed jmoo2880 closed 6 months ago

jmoo2880 commented 6 months ago

In this PR I have done the following:

  1. Updated the old README file to include a table of contents for quick access to sub-headings, improved the general aesthetic, updated all links and references so that they point to the new documentations, added a few new subheadings. Since most of the information is contained within the docs, I tried to keep it as minimal as possible and redirect the user in situations where explanations would otherwise be redundant (since they are provided in detail over at the GitBooks docs, i.e. the tutorials).
  2. Added a cool little "contributors" section at the bottom of the README which regularly updates to show the leading contributors to the repository (with corresponding profile pictures). I feel this gives a greater sense of community and bolsters the "open-source" idea quite nicely.
  3. Included a SECURITY.md, CODE_OF_CONDUCT.md. These are fairly standard for most open source, community-based packages. The code of conduct has been written to align with that in the GitBook docs. Both of these markdowns should now appear as tabs in the repository (next to "README").

Let me know if I am missing anything important with this minor update.

jmoo2880 commented 6 months ago

Just noticed that the "troubleshooting guide" link on the README directs to the editable version of the GitBook page rather than the publicly accessible (read only) one - this will appear as a dead link until it's fixed.