Skip to content

Commit

Permalink
Update contributing guide (#4542)
Browse files Browse the repository at this point in the history
* Remove libtinfo-dev from contributing guide

This dependency is not present starting from Ubuntu Noble (24.04LTS)

* Add a note about the required JDK version
  • Loading branch information
osipxd authored Dec 17, 2024
1 parent 8329b7e commit 37a9a0f
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ with some of the [low hanging fruit](https://youtrack.jetbrains.com/issues?q=%23

### Building the project

> [!IMPORTANT]
> This project requires JDK 21.
> Make sure you have JDK 21 installed before attempting to build the project.
> If you use IntelliJ IDEA, you should also select JDK 21 in **"Project Structure" > "Project" > "SDK"**
Ktor is built with Gradle. Given it is multiplatform, you can build Ktor for the JVM, Native, and JavaScript.

To build the projects and produce the corresponding artifacts, use
Expand All @@ -40,7 +45,7 @@ Run the following commands to install `libcurl` and `libncurses`:

```bash
sudo apt update
sudo apt install libncurses-dev libtinfo-dev libcurl4-openssl-dev
sudo apt install libcurl4-openssl-dev libncurses-dev
```

**macOS**
Expand All @@ -49,8 +54,7 @@ The easiest way to install `libcurl` and `libncurses` on macOS is to use [Homebr
Run the following commands:

```bash
brew install curl
brew install ncurses
brew install curl ncurses
```

If targeting macOS and/or iOS, install `Xcode` and `Xcode command line tools` on macOS.
Expand Down

0 comments on commit 37a9a0f

Please sign in to comment.