Commit Graph

49 Commits

Author SHA1 Message Date
Gerwin Klein 8f5e6540de
docs: add a guide for commit messages
Add a guide for how to write commit messages and commit message tags to
make the messages more consistent and to help new people on the project
get started more quickly.

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2024-01-17 15:21:41 +11: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
Corey Lewis c9dc6d2850 docs/setup: add step for installing cabal
Signed-off-by: Corey Lewis <corey.lewis@proofcraft.systems>
2023-07-19 10:17:21 +10:00
Rafal Kolanski 59bf9d92c8 docs: style: right- vs left-wrapping of operators
Signed-off-by: Rafal Kolanski <rafal.kolanski@proofcraft.systems>
2023-05-04 11:36:50 +10:00
Gerwin Klein 5a7e6406cd
docs/setup: mlton for M1 now available on homebrew (#624)
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2023-04-01 19:10:12 +11:00
Gerwin Klein 9ba34e2690
docs/setup: mention release manifests
Extracted from verification-manifest README which now only points to
the instructions in this repo.

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2023-03-31 15:33:50 +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 c762b99b3b
docs: fix typo in setup.md (#613)
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2023-03-16 14:12:04 +11:00
Rafal Kolanski 23a2360c76 docs: proof style on using `by`
Signed-off-by: Rafal Kolanski <rafal.kolanski@proofcraft.systems>
2023-01-25 10:12:45 +11:00
Michael McInerney 9b33cfad36 update copyright
Signed-off-by: Michael McInerney <michael.mcinerney@proofcraft.systems>
2022-11-09 15:52:50 +11:00
Michael McInerney d0b835fbb1 docs: style for ccorres statements
Signed-off-by: Michael McInerney <michael.mcinerney@proofcraft.systems>
2022-10-06 22:41:56 +10:30
Rafal Kolanski c0b29108d0 docs: update Haskell stack link
Signed-off-by: Rafal Kolanski <rafal.kolanski@proofcraft.systems>
2022-09-09 11:28:37 +02:00
Gerwin Klein 8f758375c8 docs: add mlton for x86 Apple machines
mlton installation is only tricky on M1 currently.
Intel machines have a brew package.

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2022-07-05 19:16:44 +10:00
Michael McInerney 28afa903ba docs: update Python installation instructions
Signed-off-by: Michael McInerney <michael.mcinerney@proofcraft.systems>
2022-07-05 15:06:45 +09:30
Michael McInerney e3262d7e7c docs: update setup instructions for macOS
Signed-off-by: Michael McInerney <michael.mcinerney@proofcraft.systems>
2022-07-05 15:06:45 +09:30
Ivan Velickovic e1fd4229bc docs: clarify installs work on Ubuntu 20.04/22.04
Signed-off-by: Ivan Velickovic <i.velickovic@unsw.edu.au>
2022-05-31 18:47:08 +10:00
Gerwin Klein 12c8da5758 docs: split_simps and case over fun/primrec
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2022-05-05 09:18:47 +10:00
Corey Lewis 1cef25b49a Import documentation: CRefine notes
We import some documentation with notes/issues on the refinement from
Haskell to C.

The file is a Markdown-ified version of previous documentation hosted at
UNSW.

Signed-off-by: Corey Lewis <corey.lewis@unsw.edu.au>
2022-04-27 15:37:37 +10:00
Corey Lewis 93f04fa675 docs: proof style for unfolding definitions
Signed-off-by: Corey Lewis <corey.lewis@unsw.edu.au>
2022-04-12 14:36:09 +10:00
Corey Lewis 86445726a3 docs: consistent indentation
Signed-off-by: Corey Lewis <corey.lewis@unsw.edu.au>
2022-04-12 14:36:09 +10:00
Gerwin Klein 5e705fc056 docs: text and comment style
Including an update to use that style in the style file itself.

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2022-03-28 11:06:10 +11:00
Gerwin Klein f33b02f3d0 docs: use archive link for locale docs
This link is stable over Isabelle releases and can be updated once
the repo switches over to the next release.

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-12-21 16:28:29 +11:00
Gerwin Klein 141d2f4b67 docs: fix typo
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-11-03 15:11:39 +11:00
Gerwin Klein 80a2ba76c6 docs: apply markdown lint
Rewrap and adjust list indent in conventions.md

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-11-03 15:11:39 +11:00
Gerwin Klein 715501a969 docs: variable and parameter name conventions
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-11-03 15:11:39 +11:00
Gerwin Klein 78033ab5e4 docs: bump Isabelle version in setup instructions
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-10-31 13:41:58 +11:00
Gerwin Klein 28bc26c925 isabelle-2021: HOL-Word now in HOL-Library
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2021-09-30 16:53:17 +10:00
Zoltan A. Kocsis 179a4d7acc
docs: add setup instructions for PIDE plug-ins (#319)
Signed-off-by: Zoltan Kocsis <zoltan.kocsis@data61.csiro.au>
2021-08-06 16:33:35 +10:00
Matthew Brecknell ef87791124 docs: add style guide to `run_tests`
Signed-off-by: Mitchell Buckley <mitchell.alan.buckley@gmail.com>
2021-06-29 10:57:53 +10:00
Mitchell Buckley b1f1f56fd8 docs: improvements to style guide
* Add Style_pre.thy to contain helpful preliminary definitions.
* Change some style advice according to feedback from the team.

Co-authored-by: Corey Lewis <corlewis@gmail.com>
Co-authored-by: Matthew Brecknell <matthew@brecknell.net>
Signed-off-by: Mitchell Buckley <mitchell.alan.buckley@gmail.com>
2021-06-29 10:57:53 +10:00
Gerwin Klein 087dc1ecc9 docs: Add principles/goals to style guide
The rules in this style guide should work towards achieving these
goals and form the basis for arguing whether a rule should be
there or not.

Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-06-29 10:57:53 +10:00
Mitchell Buckley 3eaa6dce22 docs: start an isabelle style guide
Add docs/Style.thy.

This is a starting point for an isabelle style guide. Some of the
material is original and some is incorporated from confluence pages.
I believe that the basics are correct but it will need to be tweaked
and corrected by other proof engineers.

Signed-off-by: Mitchell Buckley <mitchell.alan.buckley@gmail.com>
2021-06-29 10:57:53 +10:00
Gerwin Klein 59973b553d docs: hook in new Haskell assertions doc
Signed-Off-By: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-06-07 15:01:35 +10:00
Zoltan A. Kocsis ec016bba3f
Import documentation: Haskell assertions (#285)
* Import documentation: Haskell assertions

We import some documentation regarding the role of assertions in Haskell, and how we use assertions in Haskell to transport information from abstract invariants to Haskell-to-C refinement proofs.

The file is a Markdown-ified version of previous documentation hosted at UNSW and Data61.

Co-authored-by: Zoltan A. Kocsis <zoltan.kocsis@data61.csiro.au>
Co-authored-by: Matthew Brecknell <Matthew.Brecknell@data61.csiro.au>
Signed-off-by: Zoltan A. Kocsis <zoltan.kocsis@data61.csiro.au>
2021-06-03 08:24:56 +10:00
Gerwin Klein e9c7c48ed4 setup docs: markdown lint and slight tweaks
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-05-17 13:01:51 +10:00
Gerwin Klein fb150e8a7c add proog-eng plans to contents
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 16:27:42 +10:00
Gerwin Klein a250628cc5 make Jira links nicer
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 16:27:42 +10:00
Gerwin Klein fcceb13a9e Add list of proof engineering ideas
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 16:27:42 +10:00
Gerwin Klein 2a89db327c provide a table of contents
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein 400c7b7131 Japheth's guide to find_consts
Co-authored-by: Japheth Lim <Japheth.Lim@data61.csiro.au>
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein f00bf67a5a Japheth's guide to find_theorems
Co-authored-by: Japheth Lim <Japheth.Lim@data61.csiro.au>
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein 52dd5b0819 Add arch-splitting documentation
Co-authored-by: Matthew Brecknell <Matthew.Brecknell@data61.csiro.au>
Co-authored-by: Joel Beeren <joel.beeren@data61.csiro.au>
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein c2bf7fc064 Matt's short guide on de-duplicating proofs
Co-authored-by: Matthew Brecknell <Matthew.Brecknell@data61.csiro.au>
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein e810756c33 Matt's short guide on compacting proofs
Co-authored-by: Matthew Brecknell <Matthew.Brecknell@data61.csiro.au>
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10: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 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 4606fbeaed function and property variables
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-06-09 15:56:43 +10:00
Gerwin Klein aeda15d877 Add an example for function_prop pattern
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-06-09 15:56:43 +10: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