diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index 053645d..27b2c7d 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -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 @@ -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 diff --git a/README.md b/README.md index d415847..fa0bb4e 100644 --- a/README.md +++ b/README.md @@ -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` @@ -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 open-source contributors