{"id":13803866,"url":"https://github.com/impermeable/waterproof","last_synced_at":"2025-10-25T16:30:50.018Z","repository":{"id":35237058,"uuid":"209734088","full_name":"impermeable/waterproof","owner":"impermeable","description":"Waterproof is an educational environment for writing mathematical proofs in interactive notebooks. See the readme file for install instructions.","archived":false,"fork":false,"pushed_at":"2024-03-19T19:34:42.000Z","size":8116,"stargazers_count":41,"open_issues_count":31,"forks_count":6,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-01-31T08:04:39.037Z","etag":null,"topics":["coq","serapi"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/impermeable.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-20T07:42:09.000Z","updated_at":"2024-12-27T18:34:36.000Z","dependencies_parsed_at":"2024-05-03T02:58:08.606Z","dependency_job_id":"3882db0f-4c5e-456d-b848-e8b84a0012e5","html_url":"https://github.com/impermeable/waterproof","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impermeable%2Fwaterproof","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impermeable%2Fwaterproof/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impermeable%2Fwaterproof/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impermeable%2Fwaterproof/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/impermeable","download_url":"https://codeload.github.com/impermeable/waterproof/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238174135,"owners_count":19428630,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["coq","serapi"],"created_at":"2024-08-04T01:00:38.588Z","updated_at":"2025-10-25T16:30:49.332Z","avatar_url":"https://github.com/impermeable.png","language":"JavaScript","funding_links":[],"categories":["Projects","JavaScript"],"sub_categories":["User Interfaces"],"readme":"# Waterproof\n\nWaterproof is an educational tool in which students can interactively prove mathematical statements. Here is an example of an exercise and part of its solution in Waterproof.\n\nDevelop build status: [![Build Status](https://travis-ci.org/impermeable/waterproof.svg?branch=develop)](https://travis-ci.org/impermeable/waterproof)\n\n![Screenshot of waterproof](WaterproofScreenshot.png)\n\n## How to get started - Windows\n\n### Bundled installer\nDownload and execute the bundled installer `Waterproof.and.Coq.Setup.[version].exe` from the [release page](http://github.com/impermeable/waterproof/releases).\n**Note:** do not change the default installation location, otherwise Waterproof will not work.\n\n### Separate installers for dependencies and Waterproof\n* Download and execute the dependencies installer from its [release page](https://github.com/impermeable/waterproof-dependencies-installer/releases). **Note:** do not change the default installation location, otherwise Waterproof will not work.\n* Install Waterproof using the installer `Waterproof.Setup.[version].exe` from the [release page](http://github.com/impermeable/waterproof/releases).\n\n## How to get started - Linux and Mac\n\nThe easiest way to get started with Waterproof on Linux or Mac is to follow the steps:\n\n* Step 1. Install SerAPI and coq-waterproof following the steps below\n* Step 2. Install Waterproof using the installer from the [release page](http://github.com/impermeable/waterproof/releases)\n\n### Step 1 for MacOS and Linux. Installation of SerAPI.\n\nThe following steps (1.a, 1.b, 1.c and 1.d) describe how to install SerAPI and coq-waterproof on MacOS or Linux.\n\n#### Step 1.a for MacOS and Linux: Install opam\n\n##### On MacOS: \nInstall opam. You can either do so throug homebrew (https://brew.sh/) or through MacPorts (https://www.macports.org/). If you want to use homebrew, you can run the following commands in the terminal (taken from https://opam.ocaml.org/doc/Install.html#OSX)\n```\nbrew install gpatch\nbrew install opam\n```\n\nIf you prefer MacPorts, instead run\n```\nport install opam\n```\n\n##### On Linux:\nInstall opam, following instructions on https://opam.ocaml.org/doc/Install.html. For instance, for **Ubuntu**:\n```\nadd-apt-repository ppa:avsm/ppa\napt update\napt install opam\n```\n\n#### Step 1.b for MacOS and Linux: Install an OCaml compiler\n\nIn the terminal, execute the following commands (corresponding to instructions on https://ocaml.org/docs/install.html).\n\nThe first steps are common to all operating systems. First initialize the environment with\n```\nopam init\n```\nThis may take a few minutes. In the meantime, opam will likely ask two questions. We recommend choosing 'y' to both, i.e. to opam modifying the `.bash_profile` and to opam adding a hook to the init scripts. Now execute the following line\n```\neval $(opam env)\nopam switch create 4.11.1\neval $(opam env)\n```\n\n#### Step 1.c for MacOS and Linux: Install SerAPI with opam\n\nAfter installing OCaml, run the following command in the terminal:\n\n```\nopam install coq-serapi.8.15.0+0.15.2\n```\n\nOpam will ask to install several packages. Choose 'y' to install them. This step will at least take several minutes, but may take up to an hour.\n\nFinally, execute again\n\n```\neval $(opam env)\n```\n\n#### Step 1.d for MacOS and Linux: Install the coq-waterproof library\n\nNavigate in the terminal to a folder in which you are willing to place a folder with necessary library files. Then run:\n\n```\ngit clone https://github.com/impermeable/coq-waterproof\ncd coq-waterproof\nmake\nmake install\n```\n\n\n### Step 2. Install Waterproof with the installer from the release page\n\nAfter installing SerAPI, you are ready to install Waterproof using your preferred installer from the [release page](http://github.com/impermeable/waterproof/releases). After installing Waterproof, it will ask you to point to a program called **sertop**. This is located in a hidden file folder. To show hidden file folders in file chooser on MacOS press **⌘ + Shift + .** . On Linux, right-click somewhere in the file chooser and choose \"Show hidden files\".\n\n\u003e **Known issue**: Because Waterproof is relatively unknown software, it is possible that it will initially be blocked by a virus scanner. To run Waterproof anyway: **on Windows:** Choose 'run anyway', **on Mac:** right-click and choose 'open software'; you may need to go to security settings to allow for running the app.\n\n---\n\nIf you rather build the application yourself, you can follow [these steps](documentation/Cloning-the-repository.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimpermeable%2Fwaterproof","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimpermeable%2Fwaterproof","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimpermeable%2Fwaterproof/lists"}