Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README badges #624

Merged
merged 12 commits into from
Feb 27, 2024
2 changes: 1 addition & 1 deletion .github/workflows/Build-and-deploy-mac.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build-and-deploy-mac
name: Mac Release
run-name: ${{ github.actor }} is building a MAC release for NWB GUIDE

on:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/Build-and-deploy-win.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build-and-deploy-win
name: Windows Release
run-name: ${{ github.actor }} is building a Windows release for NWB GUIDE

on:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pyflask-build-and-dist-tests.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: PyFlask build and distributable tests
name: Build Tests — Flask
on:
schedule:
- cron: "0 16 * * *" # Daily at noon EST
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/testing-external.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: External Tests
name: Dev Tests (Live Services)
on:
schedule:
- cron: "0 16 * * *" # Daily at noon EST
Expand All @@ -13,7 +13,7 @@ env:

jobs:
testing:
name: External tests on ${{ matrix.os }}
name: Dev tests with live services on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
defaults:
run:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/testing.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Back-end Tests
name: Dev Tests
on:
garrettmflynn marked this conversation as resolved.
Show resolved Hide resolved
schedule:
- cron: "0 16 * * *" # Daily at noon EST
Expand All @@ -13,7 +13,7 @@ env:

jobs:
testing:
name: Back-end tests on ${{ matrix.os }}
name: Dev tests on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
defaults:
run:
Expand Down
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,28 @@
<p align="center">
<img src="src/renderer/assets/img/logo-guide-draft-transparent-tight.png" width="250" alt="NeuroConv logo"/>
<h3 align="center">NWB Graphical User Interface for Data Entry</h3>
<p align="center">
<a href="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/testing.yml"><img src="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/testing.yml/badge.svg" alt="Full Tests"></a>
CodyCBakerPhD marked this conversation as resolved.
Show resolved Hide resolved
<a href="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/testing-external.yml"><img src="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/testing-external.yml/badge.svg" alt="Full Tests with External Dependencies"></a>
<a href="https://github.com/neurodatawithoutborders/nwb-guide/actions/workflows/pyflask-build-and-dist-tests.yml"><img src="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/pyflask-build-and-dist-tests.yml/badge.svg" alt="Build and Distributable Tests"></a>
<a href="https://codecov.io/github/NeurodataWithoutBorders/nwb-guide?branch=main"><img src="https://codecov.io/github/NeurodataWithoutBorders/nwb-guide/coverage.svg?branch=main" alt="codecov"></a>
<a href="https://nwb-guide.readthedocs.io/en/latest/"><img src="https://readthedocs.org/projects/nwb-guide/badge/?version=latest" alt="Documentation"></a>
<a href="https://github.com/catalystneuro/nwb-guide/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-yellow.svg" alt="License: MIT"></a>
</p>
<p align="center">
<a href="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/Build-and-deploy-mac.yml"><img src="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/Build-and-deploy-mac.yml/badge.svg" alt="Mac Build"></a>
<a href="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/Build-and-deploy-win.yml"><img src="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/Build-and-deploy-win.yml/badge.svg" alt="Windows Build"></a>
</p>
<p align="center">
<a href="https://github.com/psf/black"><img alt="Python code style: black" src="https://img.shields.io/badge/python_code_style-black-000000.svg"></a>
<a href="https://github.com/prettier/prettier"><img alt="JavaScript code style: prettier" src="https://img.shields.io/badge/javascript_code_style-prettier-ff69b4.svg?style=flat"></a>
</p>
<p align="center">
<a href="https://join.slack.com/t/nwb-users/shared_invite/enQtNzMwOTcwNzQ2MDM5LWMyZDUwODJjYjM3MzMzYzZiNDk4ZTU3ZjQ3MmMxMmY5MDUyNzc0ZDI5ZjViYmJjYTQ5NjljOGFjZmMwOGIwZmQ"><img src="https://img.shields.io/badge/chat-Slack-lightblue?style=flat&logo=slack" alt="NWB Slack"></a>
</p>
</p>


NWB GUIDE is a desktop app that provides a no-code user interface for converting neurophysiology data to NWB.

<p align="center">
<a href="https://www.youtube.com/watch?v=z-rk2wi5BDc" target="_blank">
<img src="docs/assets/guide-video-image.png" alt="Watch the video" width="500" />
</a>
</p>


## Installation
See the installation instructions in our [documentation](https://nwb-guide.readthedocs.io/en/latest/installation.html).
Loading