When `cargo doc` generates multiple docs, it reports the last one(carousel) and --open opens it.
```
Generated .../target/doc/carousel/index.html and 26 other files
```
Specifing the package solves the issue and improves developer experience.
- Updated Quickstart and DSL docs in building.md to redirect to astro/README.md due to outdated information
- Fixed issues in astro/README.md that prevented it from working out of the box
- We don't use it anymore, so this saves us time in the CI
- Remove the completely mis-placed README and moved the typesearch relevant sections as a sub-section under "Building Documentation"
slint needs openssl to build it.
The system library `openssl` required by crate `openssl-sys` was not found.
The file `openssl.pc` needs to be installed and the PKG_CONFIG_PATH environment variable must contain its parent directory.
PKG_CONFIG_PATH contains the following:
- /usr/lib/arm-linux-gnueabihf/pkgconfig
HINT: you may need to install a package such as openssl, openssl-dev or openssl-devel.
A MSRV update is required to update the image crate to 0.25, otherwise
we get link error that are ficed in newer version.
Also other dependency update such as env_logger needs a newer MSRV.
Update to 1.73 because it has functions like `with_borrow` on thread
storage which we already actually use in some platform.
This is also the last release before the the drop of macOs < 10.12
in Rust 1.74
Many of our dependencies already made the jump and require a cargo update hack, so make it official
Removed the MSRV from the README since it applies to master branch and people read the readme also for
the released version. There is enough documentation of the MSRV in other locations.
We have plenty of command lines that explicitly use `-GNinja`, so let's
make Ninja a tool that is required. That's easier than changing all the
command lines to have two variants (use XX or YY if you have Ninja
installed), and we know that the dependency handling works best with
Ninja.
Fixes#2495
Co-authored-by: Olivier Goffart <olivier.goffart@slint-ui.com>
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).
- 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.
- 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.
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.
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.
