Skip to content

Commit

Permalink
Update format.yml (#6)
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 cb2b61a commit 6454f40
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The [Ultralytics Magellan Project](https://github.com/ultralytics/magellan) is a
# 🛠 Requirements

To harness the capabilities of the Magellan project, the following are required:

- **MATLAB**: Version 2018a or newer. Please visit [MATLAB Software](https://www.mathworks.com/products/matlab.html) for installation details.
- **Supporting Utilities**: Clone the common functions repository by executing `$ git clone https://github.com/ultralytics/functions-matlab`. After cloning, incorporate it into your MATLAB environment with `>> addpath(genpath('/functions-matlab'))`.
- **MATLAB Toolboxes**: Ensure installation of the `Statistics and Machine Learning Toolbox` and the `Signal Processing Toolbox`.
Expand All @@ -23,6 +24,7 @@ To harness the capabilities of the Magellan project, the following are required:
To utilize the Magellan software, various methods are available depending on your specific use case and expertise:

1. For a general overview of functionalities and navigation:

```matlab
% After setting up the MATLAB environment as per the requirements:
% Add your example code here with comments explaining each step
Expand Down

0 comments on commit 6454f40

Please sign in to comment.