Skip to content

Commit 4a23df7

Browse files
Merge pull request #45 from Sajjon/update_readme_links_grammar
Update README
2 parents 5d43682 + 44e2454 commit 4a23df7

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Introduction
44
Swift Numerics provides a set of modules that support numerical computing in Swift.
5-
These modules fall broadly in two categories:
5+
These modules fall broadly into two categories:
66

77
- API that is too specialized to go into the standard library, but which is sufficiently general to be centralized in a single common package.
88
- API that is under active development toward possible future inclusion in the standard library.
@@ -23,16 +23,16 @@ import Numerics
2323
```
2424

2525
Swift Numerics modules have minimal dependencies on other projects.
26-
The current modules assume only the availability of the Swift and C standard libraries, and the runtime support provided by compiler-rt.
27-
Future expansion may assume the availability of other standard interfaces such as BLAS and LAPACK, but modules with more specialized dependencies (or dependencies that are not available on all platforms supported by Swift) belong in a separate package.
26+
The current modules assume only the availability of the Swift and C standard libraries and the runtime support provided by compiler-rt.
27+
Future expansion may assume the availability of other standard interfaces such as [BLAS (Basic Linear Algebra Subprograms)](https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms) and [LAPACK (Linear Algebra Package)](https://en.wikipedia.org/wiki/LAPACK), but modules with more specialized dependencies (or dependencies that are not available on all platforms supported by Swift) belong in a separate package.
2828

29-
Because our intention is to make it possible to adopt Swift Numerics modules in the standard library at some future point, Swift Numerics uses the same license and contribution guidelines as the Swift project.
29+
Because we intend to make it possible to adopt Swift Numerics modules in the standard library at some future point, Swift Numerics uses the same license and contribution guidelines as the Swift project.
3030

3131
## Process
3232
Swift Numerics is a standalone library separate from the core Swift project.
33-
In practice it will act as a staging ground for some APIs that may eventually be incorporated into the Swift Standard Library, and when that happens such changes will be proposed to the Swift Standard Library using the established evolution process of the Swift project.
33+
In practice, it will act as a staging ground for some APIs that may eventually be incorporated into the Swift Standard Library, and when that happens such changes will be proposed to the Swift Standard Library using the established evolution process of the Swift project.
3434

35-
Swift Numerics uses github issues to track bugs and features, and pull requests for development.
35+
Swift Numerics uses GitHub issues to track bugs and features. We use pull requests for development.
3636

3737
To propose a new module:
3838
1. Raise an issue with the [new module] tag.
@@ -42,13 +42,13 @@ To propose a new module:
4242

4343
To propose a new feature for an existing module:
4444
1. Raise an issue with the [enhancement] tag.
45-
2. Raise a PR with an implementation, and discuss the implementation there.
46-
3. Once there is consensus that the new feature is desirable and the design is suitable, it can be merged.
45+
2. Raise a PR with your implementation, and discuss the implementation there.
46+
3. Once there is a consensus that the new feature is desirable and the design is suitable, it can be merged.
4747

4848
To fix a bug, or make smaller improvements:
4949
1. Raise a PR with your change. Be sure to add test coverage for whatever changes you are making.
5050

51-
Questions about how to use Swift Numerics modules, or issues that are not clearly bugs can be discussed in the "Swift Numerics" section of the Swift forums.
51+
Questions about how to use Swift Numerics modules, or issues that are not clearly bugs can be discussed in the ["Swift Numerics" section of the Swift forums.](https://forums.swift.org/c/related-projects/swift-numerics)
5252

5353
## Modules
5454
1. [Real](Sources/Real/README.md)

0 commit comments

Comments
 (0)