Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Last pass on the README : Fix #36 #247

Merged
merged 1 commit into from
Mar 21, 2025
Merged

docs: Last pass on the README : Fix #36 #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@ Please refer to the subclasses of [Document](https://kdab.github.io/knut/API/knu

<!-- NOTE: SYNC WITH docs/index.md! -->
| | 🌳 TreeSitter | 🔣 Code Items | 🧑‍💻 LSP | 🖥️ File Viewer |
|----------------------------|---------------|---------------|---------|---------------|
| C/C++ | ✅ | ✅ | ✅ | |
| C# | ✅ | ❌ | ❌ | |
| Rust | ✅ | ❌ | ❌ | |
| Dart | ❌ | ❌ | ❌ | |
| JSON | ❌ | ✔️ | ❌ | |
| [Qt Translate (.ts)][QtTs] | ❌ | ✔️ | ❌ | |
| [Qt Qml][Qml] | ✅ | ✅ | ❌ | ✅ |
| [Qt Ui files][QtUi] | ❌ | ❌ | ❌ | ✅ |
| [Slint][Slint] | ❌ | ❌ | ❌ | ✅ |
| [MFC rc files][MfcRc] | ❌ | ✔️ | ❌ | ✔️ |
| -------------------------- | -------------- | -------------- | ----------- | ----------------- |
| C/C++ | ✅ | ✅ | ✅ | |
| C# | ✅ | ❌ | ❌ | |
| Rust | ✅ | ❌ | ❌ | |
| Dart | ❌ | ❌ | ❌ | |
| JSON | ❌ | ✔️ | ❌ | |
| [Qt Translate (.ts)][QtTs] | ❌ | ✔️ | ❌ | |
| [Qt Qml][Qml] | ✅ | ✅ | ❌ | ✅ |
| [Qt Ui files][QtUi] | ❌ | ❌ | ❌ | ✅ |
| [Slint][Slint] | ❌ | ❌ | ❌ | ✅ |
| [MFC rc files][MfcRc] | ❌ | ✔️ | ❌ | ✔️ |

> ✅ Fully Supported
> ✔️ Partial Support
> ✔️ Partial Support
> ❌ Unsupported

[QtTs]: https://doc.qt.io/qt-6/linguist-ts-file-format.html
Expand All @@ -42,7 +42,6 @@ Please refer to the subclasses of [Document](https://kdab.github.io/knut/API/knu
[Slint]: https://slint.dev/
[MfcRc]: https://learn.microsoft.com/en-us/windows/win32/menurc/about-resource-files


## Requirements

Knut is using [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) servers for the GUI. It is not used for the scripts, so if you are using Knut with the command line interface, you don't need it.
Expand All @@ -64,6 +63,7 @@ This includes:

- A recent C++ compiler (GCC 11+, Clang 15+, MSVC 19.40+)
- [CMake](https://cmake.org) 3.15+
- [Perl](https://www.perl.org/)
- An installation of [Qt 6](https://www.qt.io/download-open-source)
- (optional: [Ninja build system](https://ninja-build.org/))

Expand All @@ -72,24 +72,24 @@ This is a known issue, and the steps to resolve it are detailed in the link to t

### Download Knut

To clone the code, simply run:
To clone the code and download all dependencies, simply run:

```bash
git clone https://github.com/KDAB/knut.git && cd knut
```

If you are a member of KDAB and have access to our private repositories, you may then simply run:
To download all dependencies, simply run:

- Contributor outside KDAB (download all submodules in `3rdparty/`)

```bash
git submodule update --init --recursive
git submodule update --init --recursive -- 3rdparty/*
```

to download all dependencies.

If you are a contributor outside KDAB, you will need to download all submodules in the `3rdparty/` folder, without the private dependencies in the `3rdparty-kdab/` folder.
- Member of KDAB with access to our private repositories (download all submodules in `3rdparty/` and `3rdparty-kdab/`)

```bash
git submodule update --init --recursive -- 3rdparty/*
git submodule update --init --recursive
```

### Running CMake
Expand Down
22 changes: 11 additions & 11 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ Please refer to the subclasses of [Document](https://kdab.github.io/knut/API/knu

<!-- NOTE: SYNC WITH README.md! -->
| | 🌳 TreeSitter | 🔣 Code Items | 🧑‍💻 LSP | 🖥️ File Viewer |
|----------------------------|---------------|---------------|---------|---------------|
| C/C++ | ✅ | ✅ | ✅ | |
| C# | ✅ | ❌ | ❌ | |
| Rust | ✅ | ❌ | ❌ | |
| Dart | ❌ | ❌ | ❌ | |
| JSON | ❌ | ✔️ | ❌ | |
| [Qt Translate (.ts)][QtTs] | ❌ | ✔️ | ❌ | |
| [Qt Qml][Qml] | ✅ | ✅ | ❌ | ✅ |
| [Qt Ui files][QtUi] | ❌ | ❌ | ❌ | ✅ |
| [Slint][Slint] | ❌ | ❌ | ❌ | ✅ |
| [MFC rc files][MfcRc] | ❌ | ✔️ | ❌ | ✔️ |
| -------------------------- | -------------- | -------------- | ----------- | ----------------- |
| C/C++ | ✅ | ✅ | ✅ | |
| C# | ✅ | ❌ | ❌ | |
| Rust | ✅ | ❌ | ❌ | |
| Dart | ❌ | ❌ | ❌ | |
| JSON | ❌ | ✔️ | ❌ | |
| [Qt Translate (.ts)][QtTs] | ❌ | ✔️ | ❌ | |
| [Qt Qml][Qml] | ✅ | ✅ | ❌ | ✅ |
| [Qt Ui files][QtUi] | ❌ | ❌ | ❌ | ✅ |
| [Slint][Slint] | ❌ | ❌ | ❌ | ✅ |
| [MFC rc files][MfcRc] | ❌ | ✔️ | ❌ | ✔️ |

> ✅ Fully Supported
> ✔️ Partial Support
Expand Down