Add README

This commit is contained in:
Nikita Tchayka 2023-09-17 21:56:19 +01:00
parent 2d406e38c8
commit adcf653e82
2 changed files with 50 additions and 1 deletions

BIN
.assets/img/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

View File

@ -1 +1,50 @@
# neohaskell
<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.
The repository is a mono-repo that contains all the
different parts of NeoHaskell:
- TODO: Add stuff
# 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
It's always better to hack with people, so why not joining the [Discord server](https://discord.gg/invite/wDj3UYzec8)?