Skip to content

Commit eed9b2d

Browse files
authored
Update Readme.md
1 parent 60445f2 commit eed9b2d

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

Readme.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55
[![ci](https://github.com/geospace-code/matlab-stdlib/actions/workflows/ci.yml/badge.svg)](https://github.com/geospace-code/matlab-stdlib/actions/workflows/ci.yml)
66
[![ci-nojvm](https://github.com/geospace-code/matlab-stdlib/actions/workflows/ci-nojvm.yml/badge.svg)](https://github.com/geospace-code/matlab-stdlib/actions/workflows/ci-nojvm.yml)
77

8-
Matlab or
9-
[GNU Octave](./Readme_octave.md)
10-
users coming from other languages will benefit from the functionality contained within this user-developed, unofficial "stdlib" standard library of functions.
8+
Matlab users coming from other languages like Python benefit from the functionality contained within this user-developed, unofficial "stdlib" standard library of functions.
119
These system, filesystem, and HDF5 / HDF4 / NetCDF functions are used across numerous projects.
1210

11+
Several dozen functions are [available](https://geospace-code.github.io/matlab-stdlib/), most not readily abailable elsewhere. Over 600 unit tests covering each of the backend external language interfaces are thoroughly exercised across Matlab from R2021 to the latest Matlab version across operating systems.
12+
1313
Matlab R2020b is the minimum required due to use of
14-
[arguments](https://www.mathworks.com/help/matlab/ref/arguments.html)
15-
and
16-
[mustBeTextScalar](https://www.mathworks.com/help/matlab/ref/mustbetextscalar.html)
14+
[arguments](https://www.mathworks.com/help/matlab/ref/arguments.html),
15+
[mustBeTextScalar](https://www.mathworks.com/help/matlab/ref/mustbetextscalar.html), and
16+
pattern
1717
syntax.
18-
URLs (e.g. https://, s3:// and similar) are treated as not existing.
18+
Remote URLs (e.g. https://, s3:// and similar) are treated as not existing.
1919

2020
## Self-tests
2121

22-
The self-tests require at least Matlab R2020b and can be run from the matlab-stdlib/ directory.
22+
The self-tests can be run from the matlab-stdlib/ directory.
2323

2424
Matlab R2024b and newer:
2525

@@ -40,13 +40,15 @@ Matlab older than R2022b:
4040
run('test/test_main.m')
4141
```
4242

43-
## Java-based functions
43+
## Backend
44+
45+
All non-native Matlab code functions use several fallbacks if native Matlab code isn't capable of thr task.
46+
For example, [stdlib.filesystem_type](./+stdlib/filesystem_type.m) quickly determines if Java, .NET, or Python are available--if not, a system() call is the fallback to detemrine thr filesystem type e.g. NTFS or ext4, etc.
4447

4548
Most Matlab-stdlib filesystem functions work without the
4649
[Java interface](./Readme_java.md).
47-
If Matlab was started without Java using
48-
[-nojvm](https://www.mathworks.com/help/matlab/matlab_env/commonly-used-startup-options.html),
49-
most Matlab-stdlib functions still work.
50+
even if Matlab was started without Java using
51+
[-nojvm](https://www.mathworks.com/help/matlab/matlab_env/commonly-used-startup-options.html).
5052
This
5153
[CI job](https://github.com/geospace-code/matlab-stdlib/actions/workflows/ci-nojvm.yml)
5254
tests without Java.

0 commit comments

Comments
 (0)