Git Product home page Git Product logo

book's Introduction

The Little Book of Rust Books

A catalogue of Rust mdbooks.

Pull Requests

Pull requests are welcome. Please ensure they conform to the conventions described below.

Viewing

See the rendered book.

Development

Install mdbook:

cargo install mdbook

Build the book:

mdbook build

The generated files are in the book directory.

View the built book:

mdbook serve

This will launch a local web server to serve the book. Navigate to localhost:3000 in a web browser. While the web server is running, the rendered book will automatically update if the source files change.

Conventions

Each entry is of the form:

* [The Literal Title of The Book](https://a-link-to-the/book/) - an optional comment if the title isn't self-explanatory

The .editorconfig file captures basic source files formatting conventions. Many editors support this file natively; others (such as VS code) require a plugin, see https://editorconfig.org/.

The default branch is main. See Renaming the default branch from master for the rationale.

Commit logs should describe the specific changes made by a commit. See How to Write a Git Commit Message.

Deployment

The book is deployed to the gh-pages branch by CI on a push to the main branch.

book's People

Contributors

aaronerhardt avatar adbagio avatar afoht avatar cperezz avatar danipoma avatar dpjungmin avatar dtolnay avatar esposm03 avatar glendc avatar glyn avatar hofer-julian avatar hrishim avatar ibraheemdev avatar m5tfi avatar mgeisler avatar neilweidinger avatar oblique avatar peter-kehl avatar sergiogasquez avatar ssokolow avatar tbkhi avatar tcodebk avatar tfpk avatar thedodd avatar will-low avatar willmcpherson2 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

book's Issues

Initial list of books

master branch instead of main?

Hi Glyn,

Is there any specific reason for branch/root name main rather than master?

I've spent at least a couple of minutes in confusion until I've realised it's called main. And that is after having previous commits. Imagine how it may confuse newcomers.

Should branch to other sources?

Hello,

I don't know whether you add it or not - it is not a book, but it helps to visualize memory model and form data structure based on your requirements.

I am talking about https://github.com/usagi/rust-memory-container-cs

Since I don't know if you see this repo/book as a reference to only literacy sources or as an index containing knowledge about rust. I perceive it as an index.

Kinda hard to distinct goal of this repo since it also includes docs of rust apps themselves (Amethyst Game Engine or rg3d Cheat/Guide Book), which I believe shouldn't be here since by that logic you could include whole awesome-rust into this book, but then useful information (how-tos, rust memory model etc.) would get shadowed - therefore such apps should be mentioned in awesome-rust instead.

When this book will get bigger - I see it that you accept any source - you probably also have to trim information based on their qualities.

Add a Documentation Library section

A fourth section could be appended to the current structure which would include the reference documentation for select crates such as is found here: crossbeam docs.

This could be used to fill-in for crates associated with the mdbooks from the prior sections.

For example there are mdbooks linked which involve crossbeam.rs so a link to the documentation could be included in a new Documentation Library section.

Similar to an appendices ie. Appendix A: Associated Documentation Library.

Split out application frameworks chapter

Currently, the definition of application is not clear. Perhaps we could split out a separate application frameworks chapter (see this definition, for example) and only include in the application chapter complete programs which run without needing more code to be written.

/cc @kw-fn

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.