Simon Hausmann
be47f708d9
Cleanup: Move docs/html to docs/resources
2021-07-08 07:01:51 +02:00
Simon Hausmann
ad321c7735
Use one shared html file for the syntax highlighting
...
Using Olivier's idea to check the meta tag, we can distinguish rustdoc
from "the rest". The html is included in mdbook by directly by
symlinking head.hbs.
2021-07-08 07:01:51 +02:00
Simon Hausmann
8003c06f3a
Move all HTML/CSS/JS related to preview and syntax highlighting in the docs into a shared folder
...
This will also be the place where the .60 language definition for
highlight.js can go.
2021-07-08 07:01:51 +02:00
Simon Hausmann
77898796da
Rust docs: Split up the preview from the syntax highlighting
...
The preview is now in sixtyfps-docs-preview.html and the highlighting in
sixtyfps-docs-highlight.html. This faciliates reusing the preview from
C++ while using a different HTML file later for syntax highlighting.
Relates to #282
Needed for #281
2021-07-07 14:00:04 +02:00
Tobias Hunger
39984b27db
Janitor: Fix spelling in comments
2021-07-03 15:49:43 +02:00
Simon Hausmann
8a2b665498
Remove the note about nightly Rust again
...
Those who use nightly know likely what they're doing :-)
2021-06-30 11:27:27 +02:00
Simon Hausmann
5614f4c4c8
Mention minimum requirements for macOS
...
Unfortunately we require cmake right now, due to fontkit wanting to compile
in a copy of freetype. That could be fixed though by making it use
ttf_parser perhaps.
2021-06-30 11:27:27 +02:00
Simon Hausmann
ce8f5bda24
Mention additional basic Linux dependencies
2021-06-29 22:58:36 +02:00
Simon Hausmann
5b474ecac9
Recommend the use of stable over nightly :-)
2021-06-29 22:56:04 +02:00
Tobias Hunger
e01bd87df8
Janitor: Fix warnings about markdown files
...
These might change the layout of the rendered markdown files. This will
also fix some typos along the way:-)
2021-06-28 08:32:25 +02:00
Tobias Hunger
13d7f5e7bd
Janitor: Fix typos in comments and user-facing strings
...
Also adapt tests for error messages containing the fixed strings.
No behavior change is intended!
2021-06-28 08:32:25 +02:00
Olivier Goffart
8c6eb65f1c
Few adaptations of the renamed viewer
2021-05-22 09:30:57 +02:00
Olivier Goffart
287670c140
CI: Split the C++ test driver in a different run
...
This allows to paralelize better.
And also to remove the cpp from the default workspace so it is
not build by default and the ffi feature will not be build by default
2021-03-16 16:55:49 +01:00
Simon Hausmann
1a3396da3b
Recommend the use of Ninja when using CMake
2020-12-15 18:28:24 +01:00
Olivier Goffart
45e8c94535
Some more documentation for the rust backend
2020-10-21 10:35:42 +02:00
Olivier Goffart
6075860c9e
Documentation about how to generate the doc
2020-10-13 09:54:35 +02:00
Olivier Goffart
4bdf447b11
C++ build documentation and README
2020-10-08 12:25:12 +02:00
Simon Hausmann
5e972bdf81
Add docs for building for the pi
...
Fixes : #78
2020-10-07 15:07:39 +02:00
Olivier Goffart
c3a53a360f
Additions to the building documentation
2020-09-07 10:46:02 +02:00
Simon Hausmann
e19ad3006a
Suggest to run the dynamic viewer on the printer demo instead of the less polished example :)
2020-09-04 14:56:47 +02:00
Simon Hausmann
37b10b78f8
Moved the examples build & run docs to the example folder
2020-09-04 14:55:16 +02:00
Simon Hausmann
22589f4781
A few edits to building.md
2020-08-18 15:22:57 +02:00
Olivier Goffart
41d68b6c33
Some documentation
2020-06-18 17:16:34 +02:00
