Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
G
gnome-class
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Ian P. Cooke
gnome-class
Commits
c38dc0a6
Verified
Commit
c38dc0a6
authored
Nov 17, 2018
by
Jordan Petridis
🌱
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Readme: add links to the generated docs.
aslo add installation instructions for `rustfmt`
parent
df32da74
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
12 additions
and
1 deletion
+12
-1
CONTRIBUTING.md
CONTRIBUTING.md
+1
-1
README.md
README.md
+11
-0
No files found.
CONTRIBUTING.md
View file @
c38dc0a6
...
...
@@ -160,7 +160,7 @@ account from other OAuth services.
[
syntax
]:
gobject-notes/syntax.md
[
maintainer
]:
README.md#maintainers
[
internals
]:
doc-internals/src/SUMMARY.md
[
internals-rendered
]:
https://federico.pages.gitlab.gnome.org/gnome-class/
[
internals-rendered
]:
https://federico.pages.gitlab.gnome.org/gnome-class/
book
[
mdbook
]:
https://github.com/rust-lang-nursery/mdBook
[
testing-strategy
]:
doc-internals/src/testing.md
[
gitlab
]:
https://gitlab.gnome.org/federico/gnome-class
README.md
View file @
c38dc0a6
...
...
@@ -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`
].
```
sh
rustup component add rustfmt-preview
```
[
`rustup`
]:
https://www.rustup.rs/
## How gnome-class works
...
...
@@ -143,3 +153,4 @@ ways:
[
mail
]:
mailto:federico@gnome.org
[
coc
]:
code-of-conduct.md
[
contributing
]:
CONTRIBUTING.md
[
class-docs
]:
https://federico.pages.gitlab.gnome.org/gnome-class/doc/gobject_gen/
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment