Commit graph

55 commits

Author SHA1 Message Date
Olivier Goffart
fd6c80a590 Set MSRV to 1.66 2023-02-16 09:03:22 +01:00
Simon Hausmann
3c65c6177d Fix C++ memory game tutorial not starting out of the box on Windows
After commit 3e5aa212d5 the Slint DLLs
aren't placed in the `bin/` directory by default anymore. Since the
tutorial builds Slint as an external sub-project, it is entirely
isolated and the CMAKE_*_OUTPUT_DIRECTORY variables do not propagate. On
macOS and Linux, the program still runs due to rpath. On Windows, the
instructions said to put `bin` into `%PATH%`, but that doesn't work
anymore, the dll is now in `_deps/slint-build`.

Instead of adjusting `%PATH%`, this change adjusts the documentation to
recommend the use of a custom command on Windows using
$<TARGET_RUNTIME_DLLS:tgt> to copy the DLL across. This is guarded with
WIN32 due to https://gitlab.kitware.com/cmake/cmake/-/issues/23543 ,
where the proposed solution requires CMake 3.26 (not released yet).
2023-01-09 13:30:13 +01:00
Simon Hausmann
7e77a2a4cc Bump MSRV to 1.64
... due to rust-skia bindings requiring a feature (ffi related).
2022-12-04 19:39:35 +01:00
Olivier Goffart
99b17b293c
building.md: mention the use of symlinks for Windows user
And how to get them working.
2022-11-10 20:02:18 +01:00
Tasuku Suzuki
64b248cfa9 doc: remove duplicated backticks 2022-10-28 17:44:48 +02:00
Be
8953903b90 document ways around needing xcb and fontconfig at build time 2022-10-05 15:21:54 +02:00
Simon Hausmann
c07ae0bf12 doc: bump example MSVC version from 2019 to 2022
Since we also bumped the build tools example command line a few lines above.
2022-09-22 14:10:10 +02:00
Simon Hausmann
d3f34f3bdd janitor: Fix typo 2022-09-22 14:08:46 +02:00
Simon Hausmann
67994071b0 doc: Mention gcc 10 in the C++ prerequisites 2022-09-22 12:58:04 +02:00
Simon Hausmann
2b7343c4d4 Rework the Node.js section of the build guide
- Use Node.js as the name, as that's also what's on the website
- Link to the websites of the dependencies
- Move the Node.js API prerequisites below the C++ section, in order of priority
- Create a Node.js Tests section, similar to C++, just for running the tests
- Change the remaining Node.js API build section, similar to C++, to
  explain what's needed to build it from git and how to use it.
2022-09-22 12:56:18 +02:00
Simon Hausmann
e97e12d9d9 Minor doc polish
- "can do C++20" -> "supports C++20"
2022-09-22 12:56:18 +02:00
Simon Hausmann
3c664cdd82 Various fixes to the Slint Build Guide
- In order to -> To
- Use title case for section titles
- Elaborate in the indvidual sentences about testing and building what the
  prerequisites are, what the provided command lines accomplish and where
  the output can be found.
2022-09-22 12:56:18 +02:00
Simon Hausmann
ab338cc2af Bump MSVC from 2019 to 2022
The Skia binaries on Windows are built against the 2022 runtime, so
when linking the app we also need to provide that.
2022-09-22 12:56:18 +02:00
Simon Hausmann
dcb442b013 Fix warning in suggested cargo doc command line
Also enable the log feature.
2022-09-09 10:09:07 +02:00
Simon Hausmann
5352df1c61 Enable the document-features feature for the recommended cargo doc command line 2022-09-09 10:06:00 +02:00
Simon Hausmann
f8d66cac2e Fix C++ testing instructions
There's no `test-driver-cpp` binary, but there's a package.
2022-08-18 17:00:13 +02:00
Simon Hausmann
fe3d4b7177 Bump MSRV to 1.60 2022-07-26 09:20:52 +02:00
Tobias Hunger
894ee5aa91
Do not build node by default (#1210)
Having to make sure the right version of npm is installed is a hassle
for people that just want to try out slint for the first time. The
proposed way to disable node support enables basically everything else,
which opens another can of worms when Windows tries to build MCU
support.

So do not build Node.JS as part of the default build anymore, but
document how to build it.

The CI should build with `--workspace` already, so there should be no
need to change the CI build.
2022-05-02 13:30:19 +02:00
Olivier Goffart
452bc2a696 Update MSRV to rust 1.59 in the CI and documentation
This is only required for dependencies of slint-build and xtask.
So this is not enforced yet and will still work with 1.56 with
for C++ or when not using slint-build.
2022-04-14 19:18:05 +02:00
Olivier Goffart
7f7b620a35 Update the injected scripts to the new name 2022-02-02 12:26:55 +01:00
Olivier Goffart
03534039d6 Replace more .60 by .slint
Mainly an automated change with
    git grep -O"sed -i 's/\.60/.slint/g'" -w "\.60"

and some manual checks
2022-02-02 10:12:31 +01:00
Simon Hausmann
c333b4de2b Rename the sixtyfps-cpp crate 2022-02-02 09:27:11 +01:00
Simon Hausmann
809fbfc7a6 Rename sixtyfps-node
This doesn't touch the documentation, just the package/API side
2022-02-01 22:17:35 +01:00
Olivier Goffart
d0b3adeba9 Requires C++20 2022-01-24 13:04:12 +01:00
Olivier Goffart
6babb73136 Update the MSRV to 1.56, and test the generated code with edition 2021 2022-01-24 13:01:59 +01:00
Simon Hausmann
42477db3e3 In the C++ prerequisites, link to the cmake website
It's easier that way :-)
2021-11-24 13:02:08 +01:00
Simon Hausmann
4800217f2f Document the minimum supported Rust version
cc #622
2021-11-03 16:39:41 +01:00
Olivier Goffart
72f022b3ed Document the test harness 2021-10-26 14:51:23 +02:00
Simon Hausmann
562842f19e Bump minimum required CMake version from 3.16 to 3.19
The upcoming re-organization of the C++ header generation requires the
use of the CORROSION_ENVIRONMENT_VARIABLES target property, which in
turn requires CMake >= 3.19.
2021-09-18 07:32:53 +02:00
Olivier Goffart
603c5df47a Building the doc no longer need nightly rust
Rust 1.54 has the feature that allow us to include markdown files
in the docs
2021-08-03 16:27:31 +02:00
Simon Hausmann
9c65be3538 Mention fontconfig in the Linux build requirements
We might need to centralize that with the Rust and C++ API docs though
2021-07-20 12:42:30 +02:00
Simon Hausmann
609b134a0c Remove CMake from the macOS build requirements
The development branch does not need cmake anymore due to the freetype dependency removal
2021-07-19 08:59:32 +02:00
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