Skip to content

Commit

Permalink
Add developer instructions to readme (#1252)
Browse files Browse the repository at this point in the history
* Add developer instructions to readme

* Split dependencies by platform

* Remove unneeded packages
  • Loading branch information
ahedberg committed Jan 20, 2023
1 parent c516fb4 commit c16108f
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,31 @@ mosh-client packages to allow mosh-server usage without Perl.
Notes for developers
--------------------

To start contributing to Mosh, install the following dependencies:

Debian, Windows Subsystem for Linux:

```
$ sudo apt install -y build-essential protobuf-compiler \
libprotobuf-dev pkg-config libutempter-dev zlib1g-dev libncurses5-dev \
libssl-dev bash-completion tmux less
```

MacOS:

```
$ brew install protobuf automake
```

Once you have forked the repository, run the following to build and test Mosh:

```
$ ./autogen.sh
$ ./configure
$ make
$ make check
```

Mosh supports producing code coverage reports by tests, but this feature is
disabled by default. To enable it, make sure `lcov` is installed on your
system. Then, configure and run tests:
Expand Down

0 comments on commit c16108f

Please sign in to comment.