Skip to content

Commit

Permalink
Update format.yml (#13)
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 committed Jan 1, 2024
1 parent 7eee4c0 commit cc09153
Show file tree
Hide file tree
Showing 2 changed files with 15 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
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,21 @@ In our pursuit of advancing the realm of particle detection and imaging technolo
## 📦 Requirements

Before you dive into the world of scintillation and photo-detection, you'll need to arm yourself with a few tools. Ensure you have [MATLAB](https://www.mathworks.com/products/matlab.html) version 2018a or higher at your disposal. Additionally, you'll need a set of MATLAB toolboxes geared toward statistical and signal processing. Here's how to get started:

- Clone our common functions repository using the command:

- Clone our common functions repository using the command:

```bash
$ git clone https://github.com/ultralytics/functions-matlab
```

- Integrate the repository into your MATLAB environment:

```matlab
>> addpath(genpath('/functions-matlab'))
```

Ensure the following MATLAB toolboxes are also installed:

- `Statistics and Machine Learning Toolbox`
- `Signal Processing Toolbox`

Expand Down Expand Up @@ -52,6 +55,7 @@ If this dataset and our analysis tools facilitate your research or pique your in
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 cc09153

Please sign in to comment.