Skip to content

Commit

Permalink
Reorganize README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Veykril committed Sep 19, 2020
1 parent 72ced86 commit 7e65db3
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,30 @@
# The Little Book of Rust Macros

**Note**: This is a continuation of [Daniel Keep's Book](https://github.com/DanielKeep/tlborm) which has not been updated since the early summer of 2016.
**Note**: This is a continuation of [Daniel Keep's Book](https://github.com/DanielKeep/tlborm) which
has not been updated since the early summer of 2016.

[View the rendered version](https://veykril.github.io/tlborm/).

This book is an attempt to distil the Rust community's collective knowledge of Rust macros. As such, both additions (in the form of pull requests) and requests (in the form of issues) are welcome.
This book is an attempt to distil the Rust community's collective knowledge of Rust macros,
`Macros by Example` to be precise. As such, both additions (in the form of pull requests) and
requests (in the form of issues) are welcome.

The [original Little Book of Rust Macros](https://github.com/DanielKeep/tlborm) has helped me immensely with understanding ***Macros by Example*** style macros while I was still learning the language. Unfortunately, the author of the book has since left the project untouched, while the Rust language as well as it's macro-system keeps evolving. Which is why I wanted to revive the project and keep it up to date with current Rust helping other newcomes to understand macros, a part of the language a lot of people are having trouble with, even though it is not that difficult to use once understood.
The [original Little Book of Rust Macros](https://github.com/DanielKeep/tlborm) has helped me
immensely with understanding ***Macros by Example*** style macros while I was still learning the
language. Unfortunately, the author of the book has since left the project untouched, while the Rust
language as well as it's macro-system keeps evolving. Which is why I wanted to revive the project
and keep it up to date with current Rust helping other newcomes to understand macros, a part of the
language a lot of people are having trouble with, even though it is not that difficult to use once
understood.

## Thanks

Thanks to Daniel Keep for the original work and thanks to the following people for suggestions and corrections to the original: IcyFoxy, Rym, TheMicroWorm, Yurume, akavel, cmr, eddyb, ogham, and snake_case
Thanks to Daniel Keep for the original work and thanks to the following people for suggestions and
corrections to the original: IcyFoxy, Rym, TheMicroWorm, Yurume, akavel, cmr, eddyb, ogham, and
snake_case.

## License

This work inherits the licenses of the original, hence it is licensed under both the [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/) and the [MIT license](http://opensource.org/licenses/MIT).
This work inherits the licenses of the original, hence it is licensed under both the
[Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/)
and the [MIT license](http://opensource.org/licenses/MIT).
2 changes: 2 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@ build-dir = "book"
[output.html]
default-theme = "ayu"
git-repository-url = "https://github.com/veykril/tlborm/"
# unfortunately the "Source Code Pro" font doesn't seem to work well with box characters
additional-css = ["res/code-font-patch.css"]
3 changes: 3 additions & 0 deletions res/code-font-patch.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
code {
font-family: /*"Source Code Pro",*/ Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace !important;
}

0 comments on commit 7e65db3

Please sign in to comment.