Verified Commit c38dc0a6 authored by Jordan Petridis's avatar Jordan Petridis 🌱
Browse files

Readme: add links to the generated docs.

aslo add installation instructions for `rustfmt`
parent df32da74
......@@ -160,7 +160,7 @@ account from other OAuth services.
[syntax]: gobject-notes/
[internals]: doc-internals/src/
[testing-strategy]: doc-internals/src/
......@@ -16,6 +16,8 @@ The goal of this Gnome-class crate is to let you write GObject
implementations in Rust with minimal or no boilerplate, and with
compile-time type safety all along.
The library API refference can be found **[here][class-docs]**
## Requirements
Gnome-class is a Rust procedural macro. We make use of some features
......@@ -40,6 +42,14 @@ cargo +nightly test
instead of the usual "`cargo test`" you would use for development.
Gnome-class also depends on the `rustfmt` utility which can be easily
installed with [`rustup`].
rustup component add rustfmt-preview
## How gnome-class works
......@@ -143,3 +153,4 @@ ways:
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment