Skip to content

Commit 6a8e354

Browse files
author
Dirk Seynhaeve
authored
[DOC] Fix MD so it works in fork; Solve MD lint issues (#8819)
* The original relative links were incorrect: * The **project** is hosted in the `intel/llvm` repo, but the link could be activated in a fork, which is NOT where the project is hosted. * The **wiki** is available in the `intel/llvm` repo, but the link could be clicked in a fork, where the wiki is NOT available. * The SYCL **standard extensions** documentation is available in the relative directory `./sycl/doc/extensions`, the original syntax does not follow the GitHub guidelines for relative links. * The MarkDown linter insists on alternative text for embedded pictures, which was not provided for the oneAPI logo.
1 parent 0749e4f commit 6a8e354

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,31 @@ For general contribution process see [CONTRIBUTING.md](./CONTRIBUTING.md)
88

99
## oneAPI DPC++ compiler
1010

11-
[![](https://spec.oneapi.io/oneapi-logo-white-scaled.jpg)](https://www.oneapi.io/)
11+
[![oneAPI logo](https://spec.oneapi.io/oneapi-logo-white-scaled.jpg)](https://www.oneapi.io/)
1212

1313
[![SYCL Post Commit](https://github.com/intel/llvm/actions/workflows/sycl_post_commit.yml/badge.svg?branch=sycl)](https://github.com/intel/llvm/actions/workflows/sycl_post_commit.yml)
1414
[![Generate Doxygen documentation](https://github.com/intel/llvm/actions/workflows/gh_pages.yml/badge.svg?branch=sycl)](https://github.com/intel/llvm/actions/workflows/gh_pages.yml)
1515

1616
The DPC++ is a LLVM-based compiler project that implements compiler and runtime
1717
support for the SYCL\* language. The project is hosted in the
18-
[sycl](/../../tree/sycl) branch and is synced with the tip of the LLVM upstream
19-
main branch on a regular basis (revisions delay is usually not more than 1-2
20-
weeks). DPC++ compiler takes everything from LLVM upstream as is, however some
21-
modules of LLVM might be not included in the default project build
22-
configuration. Additional modules can be enabled by modifying build framework
23-
settings.
18+
[sycl](https://github.com/intel/llvm/tree/sycl) branch and is synced with the
19+
tip of the LLVM upstream main branch on a regular basis (revisions delay is
20+
usually not more than 1-2 weeks). DPC++ compiler takes everything from LLVM
21+
upstream as is, however some modules of LLVM might be not included in the
22+
default project build configuration. Additional modules can be enabled by
23+
modifying build framework settings.
2424

2525
The DPC++ goal is to support the latest SYCL\* standard and work on that is in
2626
progress. DPC++ also implements a number of extensions to the SYCL\* standard,
27-
which can be found in the [sycl/doc/extensions](/../sycl/sycl/doc/extensions)
27+
which can be found in the [sycl/doc/extensions](./sycl/doc/extensions)
2828
directory.
2929

3030
The main purpose of this project is open source collaboration on the DPC++
3131
compiler implementation in LLVM across a variety of architectures, prototyping
3232
compiler and runtime library solutions, designing future extensions, and
3333
conducting experiments. As the implementation becomes more mature, we try to
3434
upstream as much DPC++ support to LLVM main branch as possible. See
35-
[SYCL upstreaming working group notes](/../../wiki/SYCL-upstreaming-working-group-meeting-notes)
35+
[SYCL upstreaming working group notes](https://github.com/intel/llvm/wiki/SYCL-upstreaming-working-group-meeting-notes)
3636
for more details.
3737

3838
Note that this project can be used as a technical foundation for some
@@ -49,13 +49,13 @@ Project documentation is available at:
4949
#### Docker containers
5050

5151
See available containers with pre-built/pre-installed DPC++ compiler at:
52-
[Containers](/../sycl/sycl/doc/developer/DockerBKMs.md#sycl-containers-overview)
52+
[Containers](./sycl/doc/developer/DockerBKMs.md#sycl-containers-overview)
5353

5454
#### Releases
5555

5656
Daily builds of the sycl branch on Linux are available at
57-
[releases](/../../releases).
58-
A few times a year, we publish [Release Notes](/../sycl/sycl/ReleaseNotes.md) to
57+
[releases](https://github.com/intel/llvm/releases).
58+
A few times a year, we publish [Release Notes](./sycl/ReleaseNotes.md) to
5959
highlight all important changes made in the project: features implemented and
6060
issues addressed. The corresponding builds can be found using
6161
[search](https://github.com/intel/llvm/releases?q=oneAPI+DPC%2B%2B+Compiler&expanded=true)
@@ -65,22 +65,23 @@ expected to be similar to the daily releases.
6565

6666
#### Build from sources
6767

68-
See [Get Started Guide](/../sycl/sycl/doc/GetStartedGuide.md).
68+
See [Get Started Guide](./sycl/doc/GetStartedGuide.md).
6969

7070
### Report a problem
7171

72-
Submit an [issue](/../../issues) or initiate a [discussion](/../../discussions).
72+
Submit an [issue](https://github.com/intel/llvm/issues) or initiate a
73+
[discussion](https://github.com/intel/llvm/discussions).
7374

7475
### How to contribute to DPC++
7576

76-
See [ContributeToDPCPP](/../sycl/sycl/doc/developer/ContributeToDPCPP.md).
77+
See [ContributeToDPCPP](./sycl/doc/developer/ContributeToDPCPP.md).
7778

7879
## Late-outline OpenMP\* and OpenMP\* Offload
7980

80-
See [openmp](/../../tree/openmp) branch.
81+
See [openmp](/tree/openmp) branch.
8182

8283
# License
8384

84-
See [LICENSE](/../sycl/sycl/LICENSE.TXT) for details.
85+
See [LICENSE](./sycl/LICENSE.TXT) for details.
8586

8687
<sub>\*Other names and brands may be claimed as the property of others.</sub>

0 commit comments

Comments
 (0)