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

[web] Embedded screen recordings with Asciinema #2510

Merged
merged 3 commits into from
Jun 4, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[web] Added some screen recordings for clone, config, build and tests.
  • Loading branch information
bilke committed May 29, 2019
commit 166c42b97fde57313797f3e0f95178c9c226ae47
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ CMake tries to autodetect your compiler so in most cases this should be enough:
$ cmake ../ogs
```

{{< asciinema url="https://asciinema.org/a/249004" >}}

::: {.note}
#### <i class="far fa-check"></i> Pro Tip: Use the Visual Studio command line

Expand Down
2 changes: 2 additions & 0 deletions web/content/docs/devguide/getting-started/build.pandoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ To speedup the compilation process append the number of cores of your cpu to the
$ make -j 8
```

{{< asciinema url="https://asciinema.org/a/249005" >}}

### Option: Eclipse

To let CMake generate the Eclipse project files change the generator argument to the CMake run:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,16 @@ $ git config remote.pushdefault origin
$ git config push.default current
```

**Note:** We use `git lfs clone` instead of the regular `git clone` to significantly speed up the cloning of the repo and its test data files. See [this for more information](https://github.com/ufz/ogs/pull/1978).

This creates a new folder `ogs` in your current working directory with the OGS source code. After this step, the remote called `origin` refers to your fork on GitHub. It also sets the default remote for pushes to be `origin` and the default push behavior to `current`. Together this means that if you just type `git push`, the current branch is pushed to the `origin` remote (git version >= 2.5 required).

Create a second remote called `upstream` that points at the main OGS repository and fetch from it:

```bash
$ git remote add upstream https://github.com/ufz/ogs
$ git [lfs] fetch upstream # The lfs-equivalent of the fetch command is more efficient
$ git fetch upstream
```

{{< asciinema url="https://asciinema.org/a/249002" speed="3" rows="20" >}}

## Optional: Working on a new feature

Expand Down
2 changes: 2 additions & 0 deletions web/content/docs/devguide/testing/unit-testing.pandoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ weight = 1021

Googletest is already included in the OGS source code. Running tests is as simple as building the `tests`-target.

{{< asciinema url="https://asciinema.org/a/249006" >}}

## Writing Tests

All tests are located inside the *Tests*-directory in library-specific subfolders. To write a new test you simply create a new *.cpp*-file and use the googletest macros.