Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
jim-portegies committed Nov 7, 2021
2 parents 9719cbf + afc430b commit 6b24c4e
Show file tree
Hide file tree
Showing 8 changed files with 637 additions and 158 deletions.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,29 @@ Develop build status: [![Build Status](https://travis-ci.org/impermeable/waterpr

## How to get started - Linux and Mac

The easiest way to get started with Waterproof is to follow the steps:
The easiest way to get started with Waterproof on Linux or Mac is to follow the steps:

* Step 1. Install SerAPI following the steps below
* Step 1. Install SerAPI and coq-waterproof following the steps below
* Step 2. Install Waterproof using the installer from the [release page](http://github.com/impermeable/waterproof/releases)

### Step 1 for MacOS and Linux. Installation of SerAPI.

The following steps (1.a, 1.b and 1.c) describe how to install SerAPI on MacOS or Linux.
The following steps (1.a, 1.b, 1.c and 1.d) describe how to install SerAPI and coq-waterproof on MacOS or Linux.

#### Step 1.a for MacOS and Linux: Install opam

##### On MacOS:
Install opam by running the following commands in the terminal (taken from https://opam.ocaml.org/doc/Install.html#OSX)
Install 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)
```
brew install gpatch
brew install opam
```

If you prefer MacPorts, instead run
```
port install opam
```

##### On Linux:
Install opam, following instructions on https://opam.ocaml.org/doc/Install.html. For instance, for **Ubuntu**:
```
Expand All @@ -50,11 +55,6 @@ opam init
This 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
```
eval `opam env`
```

##### On Linux or macOS:
Install OCaml with
```
opam switch create 4.11.1
eval `opam env`
```
Expand All @@ -75,9 +75,21 @@ Finally, execute again
eval `opam env`
```

#### Step 1.d for MacOS and Linux: Install the coq-waterproof library

Navigate in the terminal to a folder in which you are willing to place a folder with necessary library files. Then run:

```
git clone https://github.com/impermeable/coq-waterproof
cd coq-waterproof
make
make install
```


### Step 2. Install Waterproof with the installer from the release page

After installing SerAPI, you are ready to install Waterproof using your preferred installer from the [release page](http://github.com/impermeable/waterproof/releases).
After 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 the terminal press **⌘ + Shift + .** .

> **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.
Expand Down
27 changes: 20 additions & 7 deletions src/codemirror/tex-input.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,30 @@ export default function createTexInputHints(symbols) {
*/

function createUnicodeTable(symbols) {
let newSymbol;

for (const category of symbols) {
for (const element of category.elements) {
newSymbol = {
text: '\\' + element.name,
symbol: element.symbol,
};
unicodePreTable.push(newSymbol);
if (element.hasOwnProperty('names')) {
for (const name of element.names) {
unicodePreTable.push({
text: '\\' + name,
symbol: element.symbol,
});
}
if (element.hasOwnProperty('name')) {
console.log('WARNING: symbol has both "name" and "names"', element);
}
} else if (element.hasOwnProperty('name')) {
unicodePreTable.push({
text: '\\' + element.name,
symbol: element.symbol,
});
} else {
console.log('WARNING: symbol without name: ', element);
}
}
}

unicodePreTable.sort((a, b) => a.text.localeCompare(b.text));
}

function TeXInputHint(editor) {
Expand Down
6 changes: 4 additions & 2 deletions src/editpage/components/blocks/InputBlock.vue
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,15 @@ export default {
.input-start-block {
@include theme(border, color-primary-light, 3px solid);
border-bottom: 0;
/* We use important here since theme sets the border directly in a higher
priority style set (Same for below) */
border-bottom-width: 0 !important;
margin-bottom: 7px;
}
.input-end-block {
@include theme(border, color-primary-light, 3px solid);
margin-top: 7px;
border-top: 0;
border-top-width: 0 !important;
}
</style>
Loading

0 comments on commit 6b24c4e

Please sign in to comment.