Commit Graph

31 Commits

Author SHA1 Message Date
Gilles Peskine
f81f87f4cc API spec HTML: Use Github Pages rather than htmlpreview
htmlpreview.github.io breaks some links: in index.html viewed through
this service, the links that should go to from_doxygen.html are shown
as internal links, so the meat of the document is invisible.

Link to Github pages instead. This relies on the documentation being
available on the `master` branch of the mbed-crypto repository.

This has the added benefit of not depending on a third-party service.
2019-05-23 19:34:06 +02:00
Gilles Peskine
58501e5ecc API spec PDF: link to the actual PDF
Link to the PDF file, not to a page with an embedded PDF reader
2019-05-23 19:33:45 +02:00
Gilles Peskine
7a91ece3be Update link to PSA Crypto API HTML
Now that we aren't using Doxygen directly any longer, there is no
longer a modules.html. Link to index.html instead.
2019-05-21 20:05:34 +02:00
Gilles Peskine
800a71cc79 The specification document is now a single PDF 2019-03-05 16:03:46 +01:00
Gilles Peskine
7b3950862f Documentation: link to the specification separately
Link to rendered copies of the specification on a separate branch,
since the implementation is not always up-to-date with the
specification.

Fix the broken link to the HTML to something that works on the web.

Add instructions to generate the library documentation in HTML locally.
2019-01-31 18:10:05 +01:00
Jaeden Amero
852dac2df8 README: Update with the CMake build option
Note that one can also use CMake and doesn't strictly require GNU Make. For
instance, telling CMake to output Visual Studio project files and using
those would preclude the need for GNU Make.
2018-11-21 12:17:31 +00:00
Jaeden Amero
a49ba5ea5f README: Specify that C99 is required 2018-11-21 12:17:31 +00:00
Jaeden Amero
11293ccced README: Update with how to use as a subproject 2018-11-21 12:17:31 +00:00
Jaeden Amero
c74fe6a3e7 Add Mbed Crypto README.md
Move our Mbed Crypto README out from the crypto folder and up to the top
level for better visibility when using Mbed Crypto as a submodule of Mbed
TLS.
2018-11-21 12:16:40 +00:00
Simon Butcher
1daecb4fea Merge remote-tracking branch 'public/pr/1281' into development 2018-10-27 17:46:13 +01:00
Simon Butcher
3ad2efdc82 Remove Yotta support from the docs, tests and build scripts
Yotta is no longer supported by Mbed TLS, so has been removed. Specifically, the
following changes have been made:
 * references to yotta have been removed from the main readme and build
   instructions
 * the yotta module directory and build script has been removed
 * yotta has been removed from test scripts such as all.sh and check-names.sh
 * yotta has been removed from other files that that referenced it such as the
   doxyfile and the bn_mul.h header
 * yotta specific configurations and references have been removed from config.h
2018-09-26 17:55:09 +01:00
Simon Butcher
6965f771de Fix use of Knowledge Base in documentation
Made the use of 'Knowledge Base' consistent in the CONTRIBUTING.md and
README.md files.
2018-07-23 23:59:24 +01:00
Ron Eldor
d56654f987 Update the forum link in the README file
Update the forum link in the readme file as well.
2018-06-27 14:36:37 +03:00
Gilles Peskine
b21a085bae Show build modes in code font
This clarifies that it's the string to type and not just some
description of it.
2018-03-12 13:12:34 +01:00
Gilles Peskine
ceb7b1209c Readme with a short description of each sample program 2018-01-18 23:27:47 +01:00
Manuel Pégourié-Gonnard
976dd1674a Fix typos in previous commits 2018-01-02 10:49:46 +01:00
Manuel Pégourié-Gonnard
05c92715be readme: clarify CFLAGS prepending/overriding 2017-12-28 09:20:15 +01:00
Manuel Pégourié-Gonnard
b89c472ad5 Improve cmake usage notes in Readme 2017-12-26 12:52:53 +01:00
Gilles Peskine
5eafc74154
Merge pull request #1159 from RonEld/1862
Change Arm Trademarks
2017-11-20 17:45:49 +01:00
Ron Eldor
2ac96620f3 change URL
Change URL from developer.mbed.org to os.mbed.com
2017-11-01 14:19:50 +02:00
Ron Eldor
c7acb913ce Change Arm Trademarks
Change the Arm Trademarks according to updated Trademarks
2017-10-30 17:24:50 +02:00
RonEld
005939db98 update README file (#1144)
* update README file

update VS 2010 as the minimal version of required Visual Studio

* Rephrase the MS VS requirement

Rephrase the VS version sentence
2017-10-17 18:19:48 +01:00
Gilles Peskine
ec82da4cb2 Restored note about using minimum functionality in makefiles 2017-10-03 22:21:47 +01:00
Gilles Peskine
82759aa1c7 Note in README that GNU make is required
Our README claims that we only use basic Make functionality, but in
fact GNU make is required for conditional compilation. Document this.

Addresses issue #967
2017-10-03 22:21:33 +01:00
Andres AG
1a6e9c30f1 Add porting information to the main README 2017-02-06 16:53:30 +00:00
Jaakko Korhonen
c57c097cd5 Fixed typo in README.md
Removed an extra e from agreement.
2016-11-16 17:11:10 +00:00
Simon Butcher
741f230e78 Update to README.md
Update to contribution guidelines, some fixes in the language, minor
refinements and corrections.
2016-09-06 21:28:35 +01:00
Manuel Pégourié-Gonnard
f7a4688257 Mention new test script in Readme 2015-10-28 13:43:43 +01:00
Manuel Pégourié-Gonnard
7980096899 Further update Redmes regarding the two editions 2015-10-22 10:48:47 +02:00
Jeremie Miller
c57556e52a tiny spelling fixes 2015-09-12 09:57:23 -06:00
Manuel Pégourié-Gonnard
f851f14214 Moe top-level Readme to markdown
For consistency
2015-09-03 13:29:45 +02:00