2023-09-17 23:56:19 +03:00
|
|
|
<div align="center">
|
|
|
|
|
<img src=".assets/img/logo.png" height="256px"/>
|
|
|
|
|
<h1>NeoHaskell</h1>
|
|
|
|
|
<b>
|
|
|
|
|
NeoHaskell is a dialect of Haskell that is focused on newcomer-friendliness and productivity.
|
|
|
|
|
</b>
|
|
|
|
|
<p>
|
|
|
|
|
It is designed to be easy to learn and use, while also being powerful enough to release your app with minimum effort and maximum confidence.
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Welcome to the contributor guide
|
|
|
|
|
|
|
|
|
|
If you want to learn about NeoHaskell itself, checkout
|
|
|
|
|
[the NeoHaskell website](https://neohaskell.org).
|
|
|
|
|
|
|
|
|
|
This guide is intended for streamlining the process of
|
|
|
|
|
contributing to the NeoHaskell tooling.
|
|
|
|
|
|
2023-09-24 18:10:11 +03:00
|
|
|
The repository will be a mono-repo that contains all the
|
|
|
|
|
different parts of NeoHaskell.
|
2023-09-17 23:56:19 +03:00
|
|
|
|
|
|
|
|
# Installing the required tools
|
|
|
|
|
|
|
|
|
|
- Install GHCUP by following [the official instructions](https://www.haskell.org/ghcup/).
|
|
|
|
|
- Run `ghcup tui` and press `s` on the following options:
|
|
|
|
|
- GHC 9.2.8
|
|
|
|
|
- Cabal 3.10.1.0
|
|
|
|
|
- HLS 2.2.0.0
|
|
|
|
|
- (When prompted for download, press `y` to accept)
|
|
|
|
|
|
|
|
|
|
The recommended IDE for any NeoHaskell project is [Visual Studio Code](https://code.visualstudio.com/).
|
|
|
|
|
|
|
|
|
|
# Get the code
|
|
|
|
|
|
|
|
|
|
- Fork this repository
|
|
|
|
|
- `git clone <url to your fork>`
|
|
|
|
|
- `cd neohaskell && code .`
|
|
|
|
|
|
|
|
|
|
# Install the recommended extensions
|
|
|
|
|
|
|
|
|
|
When opening the project for the first time, you will be prompted to install the recommended extensions, install them.
|
|
|
|
|
|
|
|
|
|
# Collaborate on Discord
|
|
|
|
|
|
2023-09-24 18:10:11 +03:00
|
|
|
It's always better to hack with people, so why not joining the [Discord server](https://discord.gg/invite/wDj3UYzec8)?
|
