Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge manual repository as subtree into the manual directory of the main repo. #619

Open
wants to merge 825 commits into
base: develop
Choose a base branch
from

Conversation

cascremers
Copy link
Member

@cascremers cascremers commented Feb 26, 2024

Until now, the main code repository and manual repository were separate.
This had several disadvantages, but the main one was to keep the pull requests in sync, where we wanted code pull request authors to also submit a PR for the manual in parallel.

This merge is the result of using git subtree to merge the manual repository into the manual subdirectory of the code repository.

TODO: Modify deployment scripts to re-enable automatic deployment of the manual.

rsasse and others added 30 commits May 16, 2017 15:05
Installation notes: Tamarin via Linuxbrew
…em persistent right away (dropped 'permanent').
…ranches

The repository of the manual now has /master and /develop branches to mirror those of the main Tamarin source code repository,
Added syntax description of rule annotations (currently only colouring)
Added oracle heuristic documentation.
Add installation instructions for Arch Linux
…g as baseline, rather than the consecutive. List flag in available flags list.
Add comment about use of --quit-on-warning to 003_example.md
As of a recent version of Nixpkgs, `tamarin-prover` is a maintained, upstream package, along with Maude/SAPIC configured for it, out of the box. We're using a recent snapshot version of tamarin 1.3.0 from the `develop` branch, built with GHC 8.2.2. I've tested the TLS handshake examples with this build which seems to work fine.

This simply adds manual instructions that Nix/NixOS users will be familiar with.
… HTML. Correct Haskell Stack link in Readme
sans-sucre and others added 26 commits July 20, 2023 17:46
* subterms and numbers

* image positioning

---------
Authored by @PhilipLukertWork 
Co-authored-by: Ralf Sasse <ralf.sasse@gmail.com>
git-subtree-dir: manual
git-subtree-mainline: b3e18f6
git-subtree-split: 0e6cd6a
@cascremers
Copy link
Member Author

This first version of the PR has no changes to the deployment scripts, but since they are now no longer in the root directory, I would expect all auto-deployment to have stopped working.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet