Skip to content

Commit f981c85

Browse files
committed
[gccjit][doc] update docs
1 parent f88d050 commit f981c85

File tree

5 files changed

+39
-28
lines changed

5 files changed

+39
-28
lines changed

CMakeLists.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
cmake_minimum_required(VERSION 3.22)
2-
project(mlir-gccjit C CXX)
3-
4-
if (NOT PROJECT_IS_TOP_LEVEL)
5-
message(FATAL_ERROR "For now mlir-gccjit must be the root project during build")
6-
endif ()
2+
project(mlir-gccjit
3+
LANGUAGES C CXX
4+
)
75

86
option(MLIR_GCCJIT_BUILD_TOOLS "Build mlir-gccjit tools" ON)
97
option(MLIR_GCCJIT_ENABLE_TEST "Enable test targets in build" ON)

www/content/_index.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,23 @@ title = 'mlir-gccjit'
33
date = 2024-11-29T16:25:51+08:00
44
+++
55

6-
# mlir-gccjit
6+
<img src="/mlir-gccjit/logo.png" width="174px" height="205px" />
7+
8+
## mlir-gccjit
79

810
MLIR dialect for `libgccjit`.
11+
12+
### Discussion
13+
14+
If you have any questions about this project, check out the
15+
[discussion area](https://github.com/Lancern/mlir-gccjit/discussions).
16+
If you couldn't find satisfying answers there, feel free to
17+
[open a new discussion](https://github.com/Lancern/mlir-gccjit/discussions/new/choose).
18+
19+
### Contribution
20+
21+
We warmly welcome any kind of contributions including but not restricted to bug
22+
reports, feature requests, and pull requests. Please
23+
[open an issue](https://github.com/Lancern/mlir-gccjit/issues/new) if you have
24+
found a bug or want to request a new feature. Feel free to open a pull request
25+
if you have made any improvements to the project!

www/content/development/build.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ For Ubuntu 24.04 (noble) users:
2727
apt-get install build-essential cmake ninja-build llvm-18-dev llvm-18-tools libmlir-18-dev libgccjit-14-dev mlir-18-tools
2828
```
2929

30-
Additionally, you need the [`lit` tool] to run tests. You can install the tool
31-
via `pip`:
30+
Additionally, you need Python and the [`lit` tool] to run tests. You can
31+
install the tool via `pip`:
3232

3333
```bash
3434
pip install lit
@@ -52,13 +52,15 @@ mkdir build
5252
cd build
5353
```
5454

55-
Build with CMake:
55+
Build with CMake and `ninja`:
5656

5757
```bash
5858
cmake -G Ninja ..
59-
cmake --build .
59+
ninja
6060
```
6161

62-
## Test
62+
You can run all tests via the `check` target:
6363

64-
TODO
64+
```bash
65+
ninja check
66+
```

www/hugo.toml

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ theme = 'hugo-theme-techdoc'
88
# Source Code repository section
99
description = "An MLIR dialect for libgccjit"
1010
github_repository = "https://github.com/Lancern/mlir-gccjit"
11-
version = "0.1.0"
11+
version = ""
1212

1313
# Analytic section
1414
google_analytics_id = "" # Your Google Analytics tracking id
@@ -26,7 +26,7 @@ theme = 'hugo-theme-techdoc'
2626
# Theme color
2727
# See color value reference https://developer.mozilla.org/en-US/docs/Web/CSS/color
2828
custom_font_color = ""
29-
custom_background_color = ""
29+
custom_background_color = "#173559"
3030

3131
# Documentation Menu section
3232
# Menu style settings
@@ -51,29 +51,23 @@ theme = 'hugo-theme-techdoc'
5151
# See https://gohugo.io/content-management/menus/
5252
[menu]
5353
[[menu.main]]
54-
name = "Source"
54+
name = "Repository"
5555
weight = 1
56+
url = "https://github.com/Lancern/mlir-gccjit"
5657

57-
[[menu.main]]
58-
name = "GitHub"
59-
parent = "Source"
60-
weight = 1
61-
url = "https://github.com/Lancern/mlir-gccjit"
62-
63-
[[menu.main]]
64-
name = "Doxygen"
65-
parent = "Source"
66-
weight = 2
67-
url = "/doxygen/"
58+
[[menu.main]]
59+
name = "Releases"
60+
weight = 2
61+
url = "https://github.com/Lancern/mlir-gccjit/releases"
6862

6963
[[menu.main]]
7064
name = "Issues"
71-
weight = 2
65+
weight = 3
7266
url = "https://github.com/Lancern/mlir-gccjit/issues"
7367

7468
[[menu.main]]
7569
name = "Links"
76-
weight = 3
70+
weight = 4
7771

7872
[[menu.main]]
7973
name = "MLIR"

www/static/logo.png

74.7 KB
Loading

0 commit comments

Comments
 (0)