From c16108f0171b89fab98666be74a3298ed8aa2ced Mon Sep 17 00:00:00 2001 From: ahedberg Date: Thu, 19 Jan 2023 20:11:30 -0500 Subject: [PATCH] Add developer instructions to readme (#1252) * Add developer instructions to readme * Split dependencies by platform * Remove unneeded packages --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index ee4205e15..cf49d6762 100644 --- a/README.md +++ b/README.md @@ -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: