34 Commits
Author SHA1 Message Date
Mishal Shah e750ab6419 Update README.md to use main 2025-03-07 16:29:58 -08:00
Markus Winter 0ea36c3109 Update README.md 2022-06-16 08:16:18 +02:00
Stephen Canon 027bcc5b8e Remove conformance of Complex to Differentiable
The conformance was breaking CI testing, because the CI bots use a macOS version that predates availability of the _Differentiation module, and the compiler-generated differentation operations have neither availability attributes nor checks, so any reference to those operations simply crashes in dyld because the library is not present. We can add availability, but that's not really accurate either, because these operations are not actually binary-stable, so while we wouldn't crash in dyld, we also might not work correctly in the future. We could mark them unavailable on Apple platforms, but that's also not quite right (and further means that they're not going to get a lot of attention). The best solution seems to be to remove the conformance (which was never source-stable).
2022-04-06 14:41:04 -04:00
Stephen Canon 43e1d4d049 Update README.md
Added link to `IntegerUtilities` module.
2021-10-14 14:58:28 -04:00
Stephen Canon 9c4bd83ca4 Update README.md 2021-10-14 14:55:27 -04:00
Stephen Canon b37b64db2e Update README.md 2021-10-14 14:53:57 -04:00
Stephen Canon 0acd49c55f Take advantage of GFM footnotes in the README. 2021-10-14 14:53:35 -04:00
Stephen Canon 9837c10f9e Update README.md to refer to 1.0.0 instead of 0.1.0 2021-10-02 12:49:24 -04:00
Stephen Canon b505d3ca1d Merge pull request #198 from stephentyrone/clarify-stability-differentiable
Clarify that differentaible API is not stable.
2021-08-31 16:29:32 -04:00
Stephen Canon 63edd6769c Update README for 1.0.0. 2021-08-31 11:38:38 -04:00
Stephen Canon 3cad9b69a0 Update README.md
Update version number in sample code.
2021-02-21 21:22:01 -05:00
8bitmp3 8e580358d4 Update Swift Numerics README to address feedback 2020-09-07 14:01:43 +01:00
8bitmp3 7be984de7e Update Swift Numerics README to address feedback 2020-09-05 18:16:28 +01:00
8bitmp3 e95124c81f Revert "new uses are discovered" in Swift Numerics README 2020-09-03 18:21:31 +01:00
8bitmp3 ecfc4db4e9 Unwrap text, fix two minor syntactical errors in Swift Numerics README 2020-09-03 17:50:41 +01:00
Markus Winter f3e99a9c70 Syncs version number with latest release 2020-09-03 15:04:47 +02:00
Markus Winter 6d8d614bf2 Incorporate feedback in PR 2020-09-03 15:04:24 +02:00
8bitmp3 dcad77ec73 Enhance Swift Numerics README.md (technical writing perspective) 2020-09-02 12:58:12 +01:00
Markus Winter 6ae59362f8 Update README to reflect inclusion of Approximate Equality 2020-09-02 09:53:06 +02:00
Stephen Canon c14381db8c Add basic directions for adding a swiftpm dependency. 2020-04-13 10:58:41 -04:00
Stephen Canon be3d09ab26 Update README.md 2020-02-21 09:22:40 -05:00
Stephen Canon ba4469d3fd Update README.md 2020-02-21 09:22:40 -05:00
Stephen Canon 6951647e4c Update README.md 2020-02-21 09:22:40 -05:00
Stephen Canon a7c141e818 Update README.md 2020-02-21 09:22:40 -05:00
Stephen Canon 76954c06a7 Back to trailing 'Module' 2020-02-21 09:22:40 -05:00
Stephen Canon 4352c3a6a1 Put an underscore between the module prefix and name.
Ideally we'd be able to use Numerics.Module instead of underscore, but we can't always get what we want.
2020-02-21 09:22:40 -05:00
Sajjon 44e2454752 Update README
Formatting
Grammar & punctuation
Links
2019-11-08 16:52:30 +01:00
Zev Eisenberg 4bc7b77239 Add syntax highlighting. 2019-11-07 16:40:21 -05:00
Stephen Canon f59e64a1aa Rename ElementaryFunctions module -> Real
No change to the protocols involved, purely a change so that the module that users import shares the name of the feature they are most likely to be using, rather than a somewhat-esoteric implementation detail.
2019-11-06 12:40:12 -05:00
Stephen Canon 78042238c0 Further README improvements.
Add one README for each module, format READMEs consistently; one sentence per line to minimize diff noise.
2019-10-31 13:38:20 -04:00
Stephen Canon 29d3104da4 Beef up ElementaryFunctions README
Add a small usage example, list the operations that are available with links to Wiki for the more obscure operations, be clear about logGamma not being available on Windows.
2019-10-31 10:09:03 -04:00
Stephen Canon 5af6ff24cb Update README.md 2019-10-31 08:49:54 -04:00
Stephen Canon eb76aa632b Update license headers, add CONTRIBUTING.md and umbrella module 2019-10-30 16:11:20 -04:00
Steve (Numerics) Canon 8aab7a90f8 Initial project setup for swift-numerics
Two modules to begin with:
- ElementaryFunctions
- Complex
Added README.md files describing each module very roughly, and a project
README to describe goals and process.
2019-07-06 15:27:21 -04:00