Skip to content

Commit

Permalink
Clean-up and preparation for release v1.2 #24
Browse files Browse the repository at this point in the history
  • Loading branch information
davidvarga committed Oct 12, 2016
1 parent 3d29df4 commit b931478
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 47 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# MBeautifier

MBeautifier is a lightweight M-Script based tool that can be usable to format Matlab M-Code directly in the Matlab Editor.

MBeautifier is a lightweight M-Script based tool usable to format Matlab M-Code directly in the Matlab Editor.


Main features
Expand All @@ -16,7 +15,7 @@ Main features

Deployment and Configuration
----------------------------
Add container directory to the Matlab path, then execute: `MBeautify.setup`.
Add containing directory to the Matlab path, then execute: `MBeautify.setup()`.

This command will create the standard configuration of formatting stored in `MBeautifier\resources\settings\MBeautyConfigurationRules.m`.

Expand Down Expand Up @@ -66,3 +65,8 @@ Currently there are three approaches supported:
- Perform formatting on the currently selected text of the active page of Matlab Editor. Command: `MBeautify.formatEditorSelection()`. An optional saving mechanism as above exists also in this case. Useful in case of large files, but in any case `MBeautify.formatCurrentEditorPage()` is suggested.
- Perfrom formatting on a file. Command: `MBeautify.formatFile(file)`. Can be used with (1)one argument: the input file is formatted and remains open in the Matlab editor unsaved; (2)two arguments as `MBeautify.formatFile(file, outFile)`: the formatted file is saved to the specified output file if possible. Output can be the same as input.

Supported Matlab versions
-------------------------

As MBeautifier uses the built-in Matlab Editor functionality, it supports Matlab versions from R2011a.

44 changes: 0 additions & 44 deletions testfile.m

This file was deleted.

0 comments on commit b931478

Please sign in to comment.