Commit graph

75 commits

Author SHA1 Message Date
Simon Hausmann
a98d4709be Move printer demo and energy-monitor into new top-level demos/ folder
These are showing off use-cases for Slint, but they're not examples showing individual Slint features.

Also removed the old printerdemo while at it.
2024-10-25 12:09:32 +02:00
Olivier Goffart
66ebcbd1b7 Janitor: fix wording of the building.md docs 2024-10-16 15:30:23 +02:00
Simon Hausmann
c2ebe3ca2a Remove traces of mdbook
- 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"
2024-10-14 17:05:27 +02:00
Aurindam Jana
463031b6d8
Use Editor in Docs (#6451) 2024-10-14 15:19:29 +02:00
Olivier Goffart
fc324a4db2 Update MSRV to 1.77 2024-09-26 09:14:58 +02:00
Chris Chinchilla
ab9d7f342b
Consolidate language tutorials (#5037)
All the language tutorials are merged into the Slint reference as "quick starts".
2024-06-04 16:54:36 +02:00
Tasuku Suzuki
9ca5c63583 Fix build for raspberry pi with cross
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.
2024-05-20 08:48:51 +02:00
Chris Chinchilla
7afa34a7e1
Rename tutorial to quickstart (#4941) 2024-04-04 13:26:24 +02:00
Olivier Goffart
fd4dcfc128
Update MSRV to 1.73
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
2024-03-27 09:04:31 +01:00
Chris Chinchilla
607e325ed4
Add more details to the building read me for docs (#4414)
Add more details to the build read me file on how to build the individual docs components.
2024-01-25 10:29:15 +01:00
Jason Birbal
8fde827055
Document dependencies and add figma_import in the workspace (#4278)
- Compile figma_import as part of the workspace
 - Updated readme to reflect dependencies and workspace build instructions
2024-01-08 11:32:54 +01:00
Simon Hausmann
81a636bb5f Exclude python module from workspace wide cargo test
It doesn't quite compile like that
2023-12-21 12:57:35 +01:00
Simon Hausmann
cca6081d01 doc: Simplify Node.js test driver instructions
tests/driver/nodejs/nodejs.rs runs npm install --ignore-scripts
and npm run build:debug before running the tests, so no extra
steps should be needed.
2023-12-12 14:37:32 +01:00
Olivier Goffart
a565ed53fd Upgrade MSRV to 1.70
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.
2023-09-06 12:09:03 +02:00
Simon Hausmann
96d7bb132c reuse: remove glob for markdown files
Instead, place the copyright and license right into the source.

To satisfy reuse, this also removes the unnecessary MIT.txt
symlinks.
2023-08-17 08:55:28 +02:00
Olivier Goffart
1d3d19536e Use the dlopen feature for fontconfig
closes #2376
2023-04-19 17:25:02 +02:00
Simon Hausmann
a5bea16596
Add Ninja to the list of required tools (#2498)
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>
2023-04-11 16:35:28 +02:00
Olivier Goffart
9a51114387 Nodejs: add some documentation of the dependencies
Fix #2220
2023-03-30 09:42:00 +02:00
Tobias Hunger
42d1fbdbcf
docs: Use it's, etc. more consistently (#2287) 2023-02-24 17:42:22 +01:00
Tobias Hunger
39d215bee0 docs: Rename "Slint language Reference" to "Slint Language Documentation" 2023-02-22 21:13:47 +01:00
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