Skip to content

Commit e33671b

Browse files
committed
add website tutorial content, revamp learning fastj section
1 parent 11ef42a commit e33671b

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

wiki/intro.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,13 +96,23 @@ A few common dependencies are provided below:
9696

9797

9898
## Learning FastJ
99-
There will likely be a small wiki added for this game engine at a later time. For now, you'll want to check out [the example projects][FastJ-Example] for getting started with FastJ.
99+
There are many different ways to learn FastJ -- namely the API documentation, the examples, and the tutorials on the main website.
100100

101-
From there, explore the example code, play around with it, and read the [API documentation][Javadoc] to get a better understanding of FastJ.
101+
102+
### Tutorials
103+
[FastJ provides article tutorials][FastJ-Tutorials] on its website to accommodate as many types of developers as possible. From beginners to experts, the website tutorials are written to give enough information to satisfy anyone willing to learn!
104+
105+
106+
### Code Examples
107+
[Explore FastJ's code examples][FastJ-Examples] to see the different ways FastJ can be used, and all of its features. These come with in-example explanations and easy plug-and-playability to give you the best chance at understanding how FastJ works.
108+
109+
110+
### API Documentation
111+
[Check out FastJ's documentation][Javadoc] to get a better understanding of the code FastJ provides to improve your game-making experience.
102112

103113

104114
## Contributing to FastJ
105-
Plan on contributing to the repository? Great! Be sure to read over the [contribution guidelines][Contributing-Guidelines].
115+
Plan on contributing to the repository? Great! Be sure to read over the [contribution guidelines][Contributing-Guidelines], and read on to discover how to get started.
106116

107117

108118
### Building FastJ
@@ -118,9 +128,9 @@ Once you have what you need, follow these simple steps:
118128
```bash
119129
git clone https://github.com/fastjengine/FastJ.git
120130
```
121-
- Build the project.
131+
- Ensure that the FastJ project works on your device.
122132
```bash
123-
./gradlew build
133+
./gradlew check
124134
```
125135
_Having trouble using `gradlew`? Read [this][Terminals Are Different]._
126136

@@ -156,7 +166,8 @@ This repository is licensed under the [MIT License][MIT-License].
156166

157167
[MIT-License]: https://github.com/fastjengine/FastJ/tree/main/LICENSE.txt "MIT Licensing"
158168

159-
[FastJ-Example]: https://github.com/fastjengine/FastJ/tree/main/src/example "FastJ: Example Game"
169+
[FastJ-Tutorials]: /wiki/fastj-basics/fastj-quick-start "FastJ Tutorials"
170+
[FastJ-Examples]: https://github.com/fastjengine/FastJ/tree/main/src/example "FastJ: Example Game"
160171

161172
[Contributing-Guidelines]: https://github.com/fastjengine/FastJ/tree/main/.github/CONTRIBUTING.md "Contributing to FastJ"
162173

0 commit comments

Comments
 (0)