|
1 | | -# Haskell Editor / IDE Setup |
2 | | - |
3 | | -### Technologies used |
4 | | -[](https://www.haskell.org/) |
5 | | -[](https://nixos.org/) |
6 | | -[](https://haskell-miso.org/) |
7 | | - |
8 | | -### Community Links |
9 | | -[](https://discord.gg/9J496Nn) |
10 | | -[](https://razvan-flavius-panda.github.io/blog/) |
11 | | -[](https://www.twitch.tv/freeman42x/) |
12 | | -[](https://www.twitch.tv/freeman42x) |
13 | | - |
14 | | -### Progress Tracking |
15 | | -[](https://github.com/fairy-tale-agi-solutions/haskell-editor-setup/graphs/contributors) |
16 | | - |
17 | | -[](https://github.com/fairy-tale-agi-solutions/haskell-editor-setup/projects/1) |
18 | | -[](https://github.com/fairy-tale-agi-solutions/haskell-editor-setup/issues?q=is%3Aopen+is%3Aissue+label%3A"help+wanted") |
19 | | -[](https://github.com/fairy-tale-agi-solutions/haskell-editor-setup/issues?q=is%3Aopen+is%3Aissue+label%3A"bounty") |
20 | | -[](https://github.com/fairy-tale-agi-solutions/haskell-editor-setup/issues?q=is%3Aclosed+is%3Aissue) |
21 | | - |
22 | | -### Contributors |
23 | | -[](https://opencollective.com/fairy-tale-agi-solutions/) |
24 | | -[](https://opencollective.com/fairy-tale-agi-solutions/) |
25 | | -[](https://opencollective.com/fairy-tale-agi-solutions/) |
26 | | - |
27 | | -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. |
28 | | -<a href="https://opencollective.com/fairy-tale-agi-solutions/"> |
29 | | - |
30 | | -<img src="https://opencollective.com/fairy-tale-agi-solutions/tiers/backers.svg?avatarHeight=36"> |
31 | | -</a> |
32 | | - |
33 | | -## Automated: Haskell Editor Setup GUI program |
34 | | - |
35 | | -Work on creating a Haskell Editor Setup GUI program is in process, you can track progress here: [HES Project Kanban](https://github.com/fairy-tale-agi-solutions/haskell-editor-setup/projects/1) |
36 | | - |
37 | | -How Haskell Editor Setup will work - One click install: |
38 | | - |
39 | | -1. (optional) choose which to install: GHC, cabal, stack, nix, git, hie |
40 | | -2. (optional) choose which editors / IDEs to install |
41 | | -3. (optional) choose which editor / IDE extensions to install |
42 | | -4. Click `Configure` button and your system will be configured to have installed / set up all the things you chose. If all of them are defaults you will get everything recommended: editor, extensions etc. |
43 | | - |
44 | | -The goal of this software is mainly to allow easy editor / IDE setup for whoever tries Haskell for the first time. |
45 | | - |
46 | | -Usefulness and features of the project |
47 | | - |
48 | | -* **One Click Install** for recommended Atom and recommended extensions for it |
49 | | -* **Two Click Install** for picking your editor and recommended extensions for it |
50 | | -* customizable settings that persist across runs |
51 | | -* notify via: sounds, toast messages, etc. so that you know when system was updated |
52 | | -* hours saved by using this project: in the order of millions |
53 | | -* great UX for new Haskell learners mainly because of One Click Configuration of Atom, which is a great editor for Haskell code |
54 | | - |
55 | | -"Everything that can be automated should be automated" - Future Robot Overlords |
56 | | - |
57 | | -### Implementation progress for Atom editor: |
58 | | - |
59 | | -| **OS / Distribution** | **Implemented** | **Packaged** | **Published** | |
60 | | -| --- | --- | --- | --- | |
61 | | -| Linux - NixOS | ✔️ | ❌ | ❌ | |
62 | | -| Linux - Linux Mint | ❌ | ❌ | ❌ | |
63 | | -| Linux - Ubuntu | ❌ | ❌ | ❌ | |
64 | | -| Linux - Debian | ✔️ | ❌ | ❌ | |
65 | | -| Linux - Arch | ❌ | ❌ | ❌ | |
66 | | -| MacOS X | ❌ | ❌ | ❌ | |
67 | | -| Windows 10 | ❌ | ❌ | ❌ | |
68 | | - |
69 | | -### Donations |
70 | | - |
71 | | -You can donate to support work on Haskell Editor Setup using: https://opencollective.com/fairy-tale-agi-solutions |
72 | | - |
73 | | -All the incoming and outgoing expenses for the organization can be seen at the page above. |
74 | | - |
75 | | -The donation money will be used for funding the payment for the bounties for tickets on this project. |
76 | | - |
77 | | -### Bounties |
78 | | - |
79 | | -A bounty is a sum of money which will be rewarded on successful completion of an issue. |
80 | | - |
81 | | -The bounty issues are marked with `bounty` label and will contain in the issue title the bounty award. |
82 | | - |
83 | | -After your PR has been merged to claim a bounty reward, submit an expense using the OpenCollective link above and mention: |
84 | | - |
85 | | -1. `Haskell Editor Setup Bounty` for expense name |
86 | | -2. issue number and title in the line item description |
87 | | - |
88 | | -Very important is to attach an invoice to the expense. Send me an email at [email protected] and I will give you the details you need to fill in the invoice. Make sure to specify in the email for which pull request the invoice is. |
89 | | -Use an invoice generator for example to create the invoice. Make sure you are following all the laws in your country regarding emitting invoices. |
90 | | - |
91 | | -I will start by paying developers the following amounts for their work on issues: |
92 | | - |
93 | | -* 5 Euro for first 1 hour task they would work on |
94 | | -* 3 Euro for successive 1 hour task they would work on |
95 | | -* 1.5 Euro per hour for all other cases |
96 | | -* for special cases I can pay bigger bounties, this depends on the person taking the task, the task, etc. |
97 | | - |
98 | | -At the beginning the payments will be mainly symbolic for the developed countries yet better than average pay for non-developed ones. |
99 | | - |
100 | | -Important note: Because of transfer fees and VAT it is probable that the sum received will be smaller than the one specified in the ticket. |
101 | | - |
102 | | -Over time as this project becomes more successful and money starts flowing in through donations we will increase the pay / hour to further accelerate the pace of progress and make bounties more attractive for everyone. |
103 | | - |
104 | | -## Manual instructions for setting up Haskell editors / IDE |
| 1 | +## Instructions for setting up Haskell editors / IDE |
105 | 2 |
|
106 | 3 | HIE together with compatible plugins usually offers more features than the average Haskell multi-feature plugin + compatible plugins. Some exceptions are: IntelliJ IDEA which has a very good set of features (and HIE does not have an IDEA plugin yet) and Leksah (which also does not have a HIE plugin but offers quite a lot of features itself). |
107 | 4 |
|
|
0 commit comments