Skip to content

Commit 5fdb655

Browse files
committed
docs: Update module comment
1 parent 200abe9 commit 5fdb655

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

docs/sources.tar

512 Bytes
Binary file not shown.

src/ff.zig

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,32 @@
88
//! [![](https://play.c7.se/ff/fp8x8/shots/1.png)](https://play.c7.se/ff/fp8x8/)
99
//! [![](https://play.c7.se/ff/rng/shots/2.png)](https://play.c7.se/ff/rng/)
1010
//!
11-
//! #### You might want to install the [ff-init](https://github.com/peterhellberg/ff-init) tool and use that instead of manually creating the files for your game.
11+
//! #### You might want to install [ff-init](https://github.com/peterhellberg/ff-init)
1212
//!
13+
//! _(and use that instead of manually creating the files for your game)_
14+
//!
15+
//! ##### Installation
16+
//!
17+
//! _(Requires you to have [Go](https://go.dev/dl/) installed)_
18+
//!
19+
//! ```
20+
//! go install github.com/peterhellberg/ff-init@latest
21+
//! ```
22+
//!
23+
//! ##### Usage
24+
//!
25+
//! _(Requires you to have a recent version of
26+
//! [Zig](https://ziglang.org/download/#release-master),
27+
//! [firefly_cli](https://docs.fireflyzero.com/user/installation/#-cli), and the
28+
//! [firefly-emulator](https://docs.fireflyzero.com/user/installation/#-emulator)
29+
//! installed)_
30+
//!
31+
//! ```
32+
//! ff-init myapp
33+
//! cd myapp
34+
//! zig build run
35+
//! ```
36+
//! 🌱
1337

1438
const std = @import("std");
1539

0 commit comments

Comments
 (0)