@@ -24,16 +24,18 @@ Obelisk is an opinionated, batteries-included framework for building production-
2424 - [iOS](#ios)
2525 - [Android](#android)
2626- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)
27+- [Contributing](#contributing)
2728
2829## Overview
2930
30−### Why would I use it?
31−
3231Obelisk allows you to build high-quality web and mobile applications very quickly using [Reflex](https://reflex-frp.org/). In minutes you can go from an empty directory to a interactive application that works on web, iOS, and Android, all sharing the same Haskell codebase! Obelisk's development environment also enables extremely rapid development and feedback. You can take advantage of Haskell's type system across the frontend and backend boundary. This means changes to your backend that would break your frontend are immediately detected during development and vice versa. Obelisk uses Haskell's compiler to give you a complete "TODO list" of what needs to be updated.
3332
33+Obelisk is targeted primarily at Haskell developers who want to build high-quality web and/or mobile applications in Haskell without the distractions of manually choosing and integrating technology for every piece of the system.
34+
3435### Who should consider using it?
3536
36−Obelisk is targeted primarily at Haskell developers who want to build high-quality web and/or mobile applications in Haskell without the distractions of manually choosing and integrating technology for every piece of the system.
37+Obelisk assumes basic knowledge of Haskell, web technologies like HTML and CSS, and a terminal shell like Bash.
38+
3739
3840## Installing Obelisk
3941
@@ -167,7 +169,9 @@ The `{...}:` and following is the [NixOS module](https://nixos.org/nixos/manual/
167169
168170### Locally
169171
170−To get a full build of your app to run locally:
172+If you want deploy your application locally or test a production-oriented build you can build and deploy the app as described below.
173+
174+Build the application:
171175
172176```bash
173177nix-build -A exe --no-out-link
@@ -313,3 +317,8 @@ After having configured signing for your app, you may proceed to build a release
313317## Frequently Asked Questions (FAQ)
314318
315319Refer to [FAQ](FAQ.md).
320+
321+
322+## Contributing
323+
324+Contributions and issue reports are encouraged and appreciated! Refer to the [Contributing](CONTRIBUTING.md) guide for information about getting started.