Skip to content

Commit 830a88f

Browse files
Updated Getting Started sections. (#101)
1 parent 4ca665d commit 830a88f

File tree

2 files changed

+26
-22
lines changed

2 files changed

+26
-22
lines changed

First-outlook.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,32 @@ Things you should try out.
88

99
### ⚠️ Common pitfalls + FAQ
1010

11-
-> [Unofficial Heaps FAQ](https://gist.github.com/Yanrishatum/ae3725a9e2b45e0766c065e573ed1f24#an-unofficial-heaps-faq)
11+
[Unofficial Heaps FAQ](https://gist.github.com/Yanrishatum/ae3725a9e2b45e0766c065e573ed1f24#an-unofficial-heaps-faq)
1212

1313
### ⭐️ Github samples
1414

15-
Besides the [samples you can run online on the Heaps site](https://heaps.io/samples/) you should try the many [**samples from the github repository**](https://github.com/HeapsIO/heaps/#samples). There are many samples that haven't yet been added to the site of Heaps. The samples are already in your Haxe's Heaps folder on your local machine: `HaxeToolkit\haxe\lib\heaps\git\samples`. When compiling the `all.hxml` file all samples should get compiled (which currently takes about 227 MB of disk space).
15+
Besides the [samples you can run online on the Heaps site](https://heaps.io/samples/) you should try the many [**samples from the github repository**](https://github.com/HeapsIO/heaps/#samples).
1616

17-
Sidenote (Windows): When using HashLink you can run them very quickly when [adding HashLink to your right mouse menues](https://github.com/HaxeFoundation/hashlink/wiki/Further-Tips#working-on-windows).
17+
There are many samples that haven't yet been added to the site of Heaps. The samples are already in your Haxe's Heaps folder on your local machine: `HaxeToolkit\haxe\lib\heaps\git\samples`.
1818

19-
### 📚 Wiki / Docs
19+
When compiling the `all.hxml` file all samples should get compiled (which currently takes about 227 MB of disk space).
2020

21-
- We have many code samples and explanations on our **documentation/wiki pages** here. Have a look at all the sections. (Also compare to the [wiki pages on github](https://github.com/HeapsIO/heaps/wiki)...)
22-
- A [manual created by Mezo](https://facilitatedistaken.github.io/HeapsTutorial/)
21+
Sidenote (Windows): When using HashLink you can run them very quickly when [adding HashLink to your right mouse menues](https://github.com/HaxeFoundation/hashlink/wiki/Further-Tips#working-on-windows).
2322

2423
### 👩‍💻👨‍💻 Samples from other users
2524

26-
- You can also learn from external public repositories from other **members of the community**
25+
You can also learn from external public repositories from other **members of the community**
2726
- [Smallest-Heaps-Examples](https://github.com/Beeblerox/Simplest-Heaps-Examples) by Beeblerox
2827
- [haxe-heaps-examples](https://github.com/joereynolds/haxe-heaps-examples) by Joe Reynolds
2928

3029
### 🎈 Template games for learning
3130

32-
- Learn from **simple games** made for beginners/learning
31+
Learn from **simple games** made for beginners/learning
3332
- [[Sample games for learning]]
3433

3534
### 🐾 Step-by-step Tutorials
3635

37-
- Learn from step-by-step **tutorials**
36+
Learn from step-by-step **tutorials**
3837
- [Deepnight tutorials](https://deepnight.net/tutorials/) by Deepnight/Sébastien Bénard
3938
- [BiteSize video playlist on YouTube](https://www.youtube.com/playlist?list=PLT0YBWiI9UjE-yTXsQF8vy0t2qF5JT0-u) by Willie The Stupid Programmer
4039

@@ -46,18 +45,16 @@ Sidenote (Windows): When using HashLink you can run them very quickly when [addi
4645
### 🌐 Community
4746

4847
- Ask questions, discuss and get in touch with the **community**!
49-
- https://community.heaps.io/
50-
- join our **discord** channel: https://community.heaps.io/t/discord-official-channel/72
51-
- we also have Haxe game jams in the "JAM TIME" channel!
48+
- Discord (*#heaps* channel): https://discord.gg/sWCGm33
49+
- Discourse: https://community.heaps.io/
5250

5351
## 📒 Discover Haxe
5452

55-
- [Browse **Haxe libraries**](https://lib.haxe.org/) and benefit of the full potential of available Haxe libraries
56-
- [understanding haxelib](https://lib.haxe.org/documentation/using-haxelib/)
57-
- Becoming proficient in **Haxe** will provide you with completely new ***abilities and powers*** in your code. So learning more about what Haxe has to offer as a language gives you new options to solve things. These are just some examples (for more [visit Haxe.org](https://haxe.org/)):
58-
- the [Haxe manual](https://haxe.org/manual/)
59-
- the [Haxe API](api.haxe.org/)
60-
- the [Haxe wiki](https://github.com/HaxeFoundation/haxe/wiki) ( <- quite hidden!)
61-
- the [Haxe code cookbook](https://code.haxe.org/)
62-
- the [Haxe community](http://community.haxe.org/) (also visit haxe.org and see "Connect" options)
53+
Heaps is powered by Haxe. Learn more about Haxe here:
54+
- The [Haxe website](https://haxe.org/):
55+
- The [Haxe manual](https://haxe.org/manual/)
56+
- The [Haxe API](https://api.haxe.org/)
57+
- The [Haxe wiki](https://github.com/HaxeFoundation/haxe/wiki)
58+
- The [Haxe code cookbook](https://code.haxe.org/)
59+
- The [Haxe community](https://community.haxe.org/)
6360

Installation.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ haxelib install heaps
1717
```
1818
_Note that in some cases you might need to log out and log back into your computer for haxelib to be recognized as a command._
1919

20-
You can also install directly from github to get the latest, bleeding-edge version of Heaps (at the moment this is the recommended option).
20+
You can also install directly from github to get the latest, bleeding-edge version of Heaps (at the moment this is the **recommended** option).
21+
2122
```
2223
haxelib git heaps https://github.com/HeapsIO/heaps.git
2324
```
@@ -66,7 +67,13 @@ haxelib install hlsdl
6667
haxelib install hldx
6768
```
6869

70+
You can also install these libraries directly from github to get the latest versions (**recommended**):
71+
```
72+
haxelib git hlopenal https://github.com/HaxeFoundation/hashlink master libs/openal
73+
haxelib git hlsdl https://github.com/HaxeFoundation/hashlink master libs/sdl
74+
haxelib git hldx https://github.com/HaxeFoundation/hashlink master libs/directx
75+
```
6976
## Verify the installation
70-
Once everything is setup, you should be able to run `hl` command from your terminal:
77+
Once everything is setup, you should be able to run `hl` command from your terminal (note: the version will likely be different):
7178

7279
![image](https://user-images.githubusercontent.com/1022912/45916745-4ef11280-be6b-11e8-8d9a-9405508ff014.png)

0 commit comments

Comments
 (0)