Skip to content

Commit

Permalink
Update format.yml (#5)
Browse files Browse the repository at this point in the history
Co-authored-by: glenn-jocher <glenn.jocher@ultralytics.com>
  • Loading branch information
UltralyticsAssistant and glenn-jocher authored Jan 1, 2024
1 parent 0f32cb0 commit 1f47901
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
15 changes: 9 additions & 6 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ultralytics 🚀, AGPL-3.0 license
# Ultralytics Format Workflow
# This workflow automatically formats code and documentation in pull requests and pushes to main branch
# Ultralytics 🚀 - AGPL-3.0 license
# Ultralytics Actions https://github.com/ultralytics/actions
# This workflow automatically formats code and documentation in PRs to official Ultralytics standards

name: Ultralytics Actions

Expand All @@ -14,7 +14,10 @@ jobs:
format:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Run Ultralytics Formatting Actions
- name: Run Ultralytics Formatting
uses: ultralytics/actions@main
with:
python: true
docstrings: true
markdown: true
spelling: true
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Before diving in, make sure you have the following prerequisites:
- The following MATLAB toolboxes should be installed:
- Statistics and Machine Learning Toolbox
- Signal Processing Toolbox

Ensure that all installations and configurations match these requirements to smoothly run the NTC analysis tools.

## 🏃 Running the Tools
Expand All @@ -37,7 +37,7 @@ To begin analyzing your data:
```matlab
>> NTCviewer
```

Here is a glimpse of the kind of interface you can expect with our `NTCviewer`:

![mtcView Interface](https://github.com/University-of-Hawaii-Physics/mtc/blob/master/Analysis/Ultralytics/mtcview.png "mtcView")
Expand All @@ -47,6 +47,7 @@ Here is a glimpse of the kind of interface you can expect with our `NTCviewer`:
We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your input is invaluable. Take a look at our [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started. Also, we'd love to hear about your experience with Ultralytics products. Please consider filling out our [Survey](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge 🙏 and thank you to all of our contributors!

<!-- Ultralytics contributors -->

<a href="https://github.com/ultralytics/yolov5/graphs/contributors">
<img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/image-contributors.png" alt="Ultralytics open-source contributors"></a>

Expand Down

0 comments on commit 1f47901

Please sign in to comment.