Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 3.58 KB

README.md

File metadata and controls

51 lines (34 loc) · 3.58 KB

UFrameIT Archives

All MMT archives of formalizations needed by the UFrameIT prototype in the FrameIT project. This repository is co-released with UFrameIT as a whole, see UFrameIT's releases.

This Git repository contains the following archives as Git submodules:

  • FrameIT/frameworld: the primary formalization of knowledge UFrameIT uses
  • MitM/Core: used by FrameIT/frameworld for its formalization of 3D geometry, among others
  • MitM/Foundation: used by archives above for its formalization of logic and deduction
  • MMT/urtheories: used by archives above for its formalization of the foundation to be used (Edinburgh LF Framework)

If you just want to lurk how formalizations look like in UFrameIT, click here: https://gl.mathhub.info/FrameIT/frameworld/-/tree/devel/.

Installation

via UFrameIT-install

If you are using this repository together with UFrameIT it is highly recomendet that you install it via UFrameIT-install.

manual installation

If you want to view, edit, and update files in the formalization, follow these steps:

  1. Install MMT.

    At a minimum you need an mmt.jar, IntelliJ, and the MMT plugin for IntelliJ.

  2. Clone this repository: git clone --recurse-submodules https://github.com/UFrameIT/archives.git

    Make sure that the directories MMT (from step 1) and archives (where you clone this repository to) are sisters. In other words: from within archives, the path ../MMT/deploy/mmt.jar should resolve to the mmt.jar from step 1. (The IntelliJ "MathHub project" from the MMT IntelliJ plugin references such a relative path in its project file archives.iml.)

Updating archives

Warning: commit all your changes before running one of the following commands!

  • .\update-remote.cmd (on Windows) or .\update-remote.sh (on *nix) takes care of a longish sequence of Git commands to update all submodules to the latest remote commit.
    If everything works and you have the needed git permissions, please commit and push the update.
  • .\update.cmd (on Windows) or .\update.sh (on *nix) updates to the version committed on the current branch in the archives repo.

compiling the archives

  1. Make sure you have an up to date mmt.jar located in ../MMT/deploy/mmt.jar relative to the archives repository.
  2. Run .\build.cmd (on Windows) or .\build.sh (on *nix)

In case of errors

Often using clean.sh can resolve weird errors that might pop up. It can be used on Windows via the git bash.