diff --git a/.assets/img/logo.png b/.assets/img/logo.png new file mode 100644 index 0000000..19855bc Binary files /dev/null and b/.assets/img/logo.png differ diff --git a/README.md b/README.md index eb1d03b..3a1888a 100644 --- a/README.md +++ b/README.md @@ -1 +1,50 @@ -# neohaskell \ No newline at end of file +
+ +

NeoHaskell

+ + NeoHaskell is a dialect of Haskell that is focused on newcomer-friendliness and productivity. + +

+ 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. +

+
+ +--- + +# 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 ` +- `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)? \ No newline at end of file