Skip to content

Commit 628f9dc

Browse files
committed
updated readme with example projects notice
1 parent ce76dcf commit 628f9dc

File tree

2 files changed

+37
-9
lines changed

2 files changed

+37
-9
lines changed

README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,9 @@ A few common dependencies are provided below:
7878

7979
## Learning FastJ
8080

81-
There will likely be a small wiki added for this game engine at a later time. For now, you'll want to check out [this example code][FastJ-Example] for getting started with FastJ.
81+
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.
8282

83-
As for seeing that example in action, you'll need to clone the repository, and run the gradle task `example`:
84-
```bash
85-
git clone https://github.com/lucasstarsz/FastJ.git
86-
./gradlew example
87-
```
88-
_Having trouble using `gradlew`? Read [this][Terminals Are Different]._
89-
90-
From there, explore the [example code][FastJ-Example], play around with it, and read the documentation to get a better understanding of FastJ.
83+
From there, explore the example code, play around with it, and read the [API documentation][Javadoc] to get a better understanding of FastJ.
9184

9285
## Contributing to FastJ
9386
Plan on contributing to the repository? Great! Be sure to read over the [contribution guidelines][Contributing-Guidelines].

src/example/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Examples
2+
3+
4+
As for seeing that example in action, you'll need to clone the repository.
5+
```bash
6+
git clone https://github.com/lucasstarsz/FastJ.git
7+
```
8+
9+
Then, run the gradle task `example`. When you do this, you'll need to specify which example you want to run. This can be done by adding `-P<example project name, without the brackets>`
10+
```bash
11+
./gradlew example -Pexample=helloworld
12+
```
13+
_Having trouble using `gradlew`? Read [this][Terminals Are Different]._
14+
15+
## Example Projects
16+
17+
### Hello, World!
18+
This project is an introduction to working with FastJ, and covers many of the essential topics:
19+
- Engine Initialization/Running
20+
- Window Creation
21+
- Working with a Scene
22+
- Drawing game objects and UI
23+
- Applying Behaviors to Game Objects
24+
25+
Command to run: `./gradlew example -Pexample=helloworld`
26+
27+
### Bullet Hell
28+
This project takes the concepts we've learned so far and meshes them together into a game!
29+
30+
**WARNING: UNFINISHED PROJECT**
31+
32+
Command to run: `./gradlew example -Pexample=bullethell`
33+
34+
35+
[Terminals Are Different]: https://gist.github.com/lucasstarsz/9bbc306f8655b916367d557043e498ad "Terminals Access Files Differently"

0 commit comments

Comments
 (0)