Commit Graph

20 Commits

Author SHA1 Message Date
Martin Kroeker 7006492863
replace "Preview" in the MSVC vcvarsall path with "Community" 2024-07-26 12:49:57 +02:00
Ralf Gommers 268dcd8f45 docs: convert remaining install sections (Android, iOS, FreeBSD, Cortex-M) 2024-07-04 19:16:30 +02:00
Ralf Gommers 452014341e docs: rework building from source on Windows section 2024-07-04 19:16:30 +02:00
Ralf Gommers 4547908901 docs: rewrite "Install OpenBLAS" page (part 1: binaries, basic from source) 2024-07-04 19:15:51 +02:00
Ralf Gommers c1c0dbfd60 docs: address review comments on PR 4774 2024-07-02 14:05:47 +02:00
Ralf Gommers ca9a0c28e8 docs: improve extensions page 2024-06-30 18:04:12 +02:00
Ralf Gommers 3eba16c583 docs: improve the Developer manual 2024-06-30 18:04:08 +02:00
Ralf Gommers a8e1ff84ce docs: improve the "Build system" page 2024-06-30 16:27:54 +02:00
Ralf Gommers c1b9bb8519 docs: improvements to the User Manual 2024-06-30 16:18:24 +02:00
Ralf Gommers 237c2c4130 docs: fix footnote rendering on "Redistributing OpenBLAS" page 2024-06-30 16:09:00 +02:00
Ralf Gommers 3a8e72c0e6 docs: improve the "About" documentation page 2024-06-30 16:08:56 +02:00
Martin Kroeker a82ecadc11
mention LD_LIBRARY_PATH 2024-05-04 15:48:48 +02:00
cyk 95315f95d2
Update user_manual.md for static linker
when I use static link method to compile , result is undefined with pthread_create, so we should add -lpthread
2024-04-06 13:51:01 +08:00
Matthew Barber 45cbabcf58 Improve `index.md`
* Fix typo
* Improve platforms sentence
2024-03-20 11:19:51 +00:00
Matthew Barber 51a465a162 Mailing list doc updates 2024-03-20 11:13:21 +00:00
Matthew Barber 7a8b1d40a2 Address review comments
* Update backers link to OpenBLAS repo
* Remove reference to Bountysource
2024-03-20 11:13:21 +00:00
Matthew Barber 27841b8b44 More doc improvements
* Fold "Users of OpenBLAS", "Publications", "Mailing list", "Donation" pages into "About"
* Remove full license
* Remove outdated TODO and machine list pages
* Shorter titles for CI and distributing pages
* Link to GotoBLAS readme in repo
* Brief description of OpenBLAS in homepage
* Move acknowledgements into About page
* Remove manual TOC in FAQ docs
2024-03-20 11:13:21 +00:00
Matthew Barber 9cfcee131e Doc improvements squish
* Fix more broken links
* Move FAQ last
* Fold all install-y content into `install.md`
* Fix header levels
* Fold `download.md` contents into `install.md`
* Fix cross-references
* Ordered navigation
* Add logo to docs
* Make doc pages more consistent
2024-03-20 11:13:14 +00:00
Matthew Barber 2aee9a8a7d Move wiki contents to `docs/` 2024-03-14 08:45:49 +00:00
Ralf Gommers ee72575475 Add documentation on redistributing OpenBLAS
This touches on the following:

- build configurations
- naming of symbols, shared/static libraries and other build outputs
  like pkg-config and CMake files
- (in more detail) guidance on ILP64 builds

It tries to explain that, while this is only guidance and there may be
reasons to deviate from that, for some build options there are best
practices, and for some others there are choices to make.

It also links to a number of well-maintained build recipes in order
to help packagers of other distros make choices.

Closes gh-3798

[skip ci]
2023-07-26 23:37:28 +02:00