Commit Graph

61 Commits

Author SHA1 Message Date
Achim D. Brucker 38fcd0caf2 Updated repository description. 2024-01-27 14:09:25 +00:00
Gerwin Klein b6645c1a06 docs+README: update Isabelle links to https
Link to canonical https location; link checker is too impatient for the
redirect.

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2024-01-17 15:21:06 +11:00
Gerwin Klein 7b0599a035
README: flatten installation instructions
- Provide one flattened set of instructions to install all
  dependencies, google repo, manifest checkout, and Isabelle
  installation. At the end of it, link to the description on how to run
  the proofs.

- Remove jEdit section from main README, since it's duplicated in
  `setup.md`.

- update Google repo link to a page that contains installation
  instructions

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2023-03-31 15:22:45 +11:00
Gerwin Klein 244e7d464f
readme: explain L4V_ARCH and spec generation (#586)
We have so far not been mentioning L4V_ARCH in the instructions and
haven't pointed out which sessions need generated input.

Add this information to the instructions.

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2023-03-01 16:53:37 +11:00
Gerwin Klein 81b95eb6bf READMEs: fix publication links
PDFs and abstracts have moved to trustworthy.systems/

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-08-25 11:22:05 +10:00
Gerwin Klein 6bb3f6e64f README.md: show CI status for master and rt
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-08-14 15:59:10 +10:00
Gerwin Klein bf5b97500a trivial: fix links to papers
The TS website has settled on no `.pml` postfix

Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-03-02 11:44:22 +11:00
Corey Lewis be9175c5bf readme: use -R instead of -l
Signed-off-by: Corey Lewis <Corey.Lewis@data61.csiro.au>
2021-01-08 16:01:51 +11:00
Gerwin Klein b9a48d8042
docs: factor out dependency specs (#161)
There is another (out-of-date) dependency description for l4v on the
docs site. To avoid this duplication, this commit factors out the
dependency part of the README, so that it be included directly on the
docs site without going stale.

Also, the README was getting way too long.

Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-12-02 12:32:26 +11:00
Gerwin Klein ba38ae33ab update publications links
The links to nicta.com.au have stopped working, so the publication links
now point to the TS publication pages.

Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-11-23 17:06:46 +11:00
Gerwin Klein dbc735c81d
readme/docs: update comments to Isabelle2020
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-10-27 16:55:33 +10:00
Gerwin Klein b0d01265ef trivial: fix broken links
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-08-10 15:48:34 +08:00
Gerwin Klein eefaa6db97 docs: an initial guide on naming conventions
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-06-09 15:56:43 +10:00
Matthew Brecknell cf48906b26 regression: force use of python3
Python 2 has passed its sunset date, and many distributions are
withdrawing support for Python 2.

PEP 394 recommends distributions always install versioned interpreter
commands (e.g. `python3`), but does not make a recommendation about
whether or not an unversioned command (`python`) should exist, or what
version it should run.

It therefore seems advisable to explicitly run scripts using the
`python3` command, for scripts that are compatible with Python 3.

Here, we do this for Python scripts used by `run_tests`. For this to
work, some scripts have been updated in ways that will break Python 2
compatibility. But for some other scripts which were already compatible
with both Python 2 and 3, we have not yet removed Python 2
compatibility. There are also miscellaneous scripts that are not used by
`run_tests`, and these have not yet been updated to Python 3.

Signed-off-by: Matthew Brecknell <Matthew.Brecknell@data61.csiro.au>
2020-04-01 14:31:36 +11:00
Gerwin Klein c725ebd7e8 Update license information and move to LICENSE.md
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-03-31 10:08:14 +08:00
Gerwin Klein c68915b92b license: provide documentation under CC-BY-SA-4.0
Datat61 provides all docs under CC-BY-SA-4.0.
2020-03-16 14:19:15 +08:00
Gerwin Klein a424d55e3e licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
Gerwin Klein 8d12d8e4be licenses: tag .md and document file 2020-03-02 18:52:15 +08:00
Edward Pierzchalski 831d3b4f70 docs: clarify installation instructions
Miscellaneous changes to make instructions easier to follow, as well as
updating instructions for Haskell Stack (which is no longer available on
Debian Testing).
2019-11-14 16:12:49 +11:00
Edward Pierzchalski f6599e9ce3 docs: update mlton-compiler instructions.
Move `mlton-compiler` to the end of the apt-get list so it's easier for
a user to leave it off.

Point the user to the mlton website when installing on Debian Buster,
since there's no maintained mlton package for that distribution.
2019-08-09 16:02:26 +10:00
Edward Pierzchalski 03411f7bdb docs: add python3 installation dependencies.
seL4 and L4V are migrating to python 3 given the upcoming end of python
2's support. Until we've rooted out all the old scripts, we recommend
installing both systems.
2019-08-05 17:05:25 +10:00
Gerwin Klein 4e12863b0f docs: update README files for Isabelle2019 2019-06-14 11:41:21 +10:00
Edward Pierzchalski 4e56da06dd docs: Add section on JEdit
- Add instructions for installing the `goto-error` macro in a place
  where we might be able to find them.
- Mention the improved auto-indenter, in the hope that we will use it
  when writing proofs.
2019-05-10 10:43:15 +10:00
Edward Pierzchalski e4f0651f6b docs: Update installation instructions.
Figuring out that you need to install an extra package _after_ waiting
three hours for CRefine to build isn't fun. Changes the installation
instructions to be like most other projects, i.e. "here is everything
you'll need for anything you'll want to do".
2019-04-29 16:44:39 +10:00
Gerwin Klein eea38b25c4 Isabelle2018: READMEs and docs 2018-08-20 09:06:36 +10:00
Japheth Lim 6d0a9a78aa fix incorrect path in readme 2018-05-30 15:24:57 +10:00
Japheth Lim 2e475a268f update build instructions in readme to use make
JIRA VER-915
2018-03-29 14:21:07 +11:00
Gerwin Klein ba97e55d1f docs: Isabelle2016-1 -> Isabelle2017 2018-03-08 08:33:18 +11:00
Gerwin Klein ebfc7ec171 README.md: zenodo png -> svg; move DOI tag up 2018-03-01 16:59:39 +11:00
Gerwin Klein d04547b124 link to all-version DOI in README.md 2018-01-29 09:58:43 +11:00
Gerwin Klein eca624104c update python dependencies in README 2017-07-28 15:10:47 +10:00
Alejandro Gomez-Londono 796887d9b1 Removes all trailing whitespaces 2017-07-12 15:13:51 +10:00
Matthew Brecknell d08ee04e2f haskell: update documentation for building the Haskell kernel 2017-02-03 16:23:56 +11:00
Gerwin Klein 1e6686d66c Isabelle2016-1: update README 2017-01-07 14:20:54 +01:00
Gerwin Klein 67269edb13 docs: update installation instructions
The bitfield generator in seL4/ now also depends on the `six` package.
2016-09-18 16:36:03 +10:00
Gerwin Klein 081c7337a0 README: adjusted latex dependencies and Isabelle version
closes github issue #11
2016-06-30 09:02:46 +10:00
Japheth Lim d4932618eb Add Haskell kernel to README 2016-05-24 16:02:05 +10:00
Gerwin Klein a4519c5246 update README and CONTRIBUTING links
(after seL4.systems update)
2015-10-14 09:52:05 +11:00
Gerwin Klein b986b6d35f README: back to production mode 2015-05-28 18:26:53 +10:00
Gerwin Klein ca88de6611 Merge from master. 2015-05-26 07:47:54 +10:00
Gerwin Klein bfe0cf85d1 bump to 2015 2015-05-16 19:55:42 +10:00
Gerwin Klein a775e1238f more detailed dependency description 2015-04-21 15:55:43 +01:00
Gerwin Klein ce33a07662 add update notice 2015-04-17 16:22:45 +01:00
Gerwin Klein 8e77f3b6a8 link to CONTRIBUTING.md 2015-01-27 11:14:51 +11:00
Gerwin Klein da5a86c618 remove now obsolete instructions about TOOLPREFIX 2015-01-22 13:46:01 +11:00
Gerwin Klein 28bdd742f9 also mention `make` version 2015-01-22 13:31:08 +11:00
Gerwin Klein db1f1b60de document missing texlive dependency;
Also comment more on `TOOLPREFIX` for now (until we have a better solution).
2015-01-22 12:47:32 +11:00
Gerwin Klein 939d98843c Isabelle 2013-2 -> 2014 in docs 2014-10-21 20:08:50 +11:00
Gerwin Klein 9ccfacc2fb Dragons slain, Isabelle2014 update complete. 2014-10-21 19:53:41 +11:00
David Greenaway cf0d1abce6 Merge 'master' into 'isabelle-2014'.
Conflicts:
	proof/crefine/Fastpath_C.thy
	proof/drefine/KHeap_DR.thy
	proof/infoflow/Noninterference.thy
	spec/design/version
	sys-init/DuplicateCaps_SI.thy
	sys-init/InitTCB_SI.thy
	sys-init/Proof_SI.thy
	tools/asmrefine/SimplExport.thy
	tools/autocorres/tests/examples/SchorrWaite.thy
2014-09-17 14:21:13 +10:00