diff options
| author |  ahedberg <ahedberg@google.com> | 2023-01-19 20:11:30 -0500 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2023-01-19 20:11:30 -0500 |
| commit | c16108f0171b89fab98666be74a3298ed8aa2ced (patch) | |
| tree | a83711e69efb52d8ff1bc0bc35556de603fee7f3 | |
| parent | c516fb42561e5e537266e1d350a76d5105f93aff (diff) | |
Add developer instructions to readme (#1252)
* Add developer instructions to readme
* Split dependencies by platform
* Remove unneeded packages
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
@@ -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: |