Skip to content

Commit d38a97a

Browse files
Added links to online documentation
1 parent 349d981 commit d38a97a

File tree

7 files changed

+19
-12
lines changed

7 files changed

+19
-12
lines changed

DiligentCore

DiligentSamples

DiligentTools

Doc/.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
__pycache__
1+
__pycache__
2+
pages.dox

Doc/doxygen.cfg

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ PROJECT_ICON =
7474
# entered, it will be relative to the location where Doxygen was started. If
7575
# left blank the current directory will be used.
7676

77+
# NB: the same path must specified in the documentation build action
78+
# https://github.com/DiligentGraphics/DiligentGraphics.github.io/blob/master/.github/workflows/download-and-deploy-artifacts.yml
7779
OUTPUT_DIRECTORY = build/docs
7880

7981
# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22
**A Modern Cross-Platform Low-Level 3D Graphics Library and Rendering Framework**
33
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=An%20easy-to-use%20cross-platform%20graphics%20library%20that%20takes%20full%20advantage%20of%20%23Direct3D12%20and%20%23VulkanAPI&url=https://github.com/DiligentGraphics/DiligentEngine)
44

5-
[Diligent Engine](http://diligentgraphics.com/diligent-engine/) is a lightweight cross-platform graphics
6-
API abstraction library and rendering framework. It is designed to take full advantage of Direct3D12, Vulkan,
7-
Metal and WebGPU, while supporting older platforms via Direct3D11, OpenGL, OpenGLES and WebGL. Diligent Engine
8-
exposes common front-end API and uses HLSL as universal shading language on all platforms and rendering back-ends.
9-
Platform-specific shader representations (GLSL, MSL, DX bytecode or SPIRV) can be used with corresponding back-ends.
10-
The engine is intended to be used as graphics subsystem in a game engine or any other 3D application.
11-
It is distributed under [Apache 2.0 license](License.txt) and is free to use.
5+
Diligent Engine is a lightweight, high-performance graphics API abstraction layer and rendering framework for cross-platform development.
6+
It leverages the power of modern graphics APIs such as Direct3D12, Vulkan, Metal, and WebGPU, while also maintaining robust support for
7+
legacy platforms through Direct3D11, OpenGL, OpenGLES, and WebGL.
8+
Providing a consistent front-end API, Diligent Engine uses HLSL as its universal shading language and also supports platform-specific
9+
shader formats (GLSL, MSL, DirectX bytecode, SPIR-V) for optimized performance.
10+
Ideal for game engines, interactive simulations, and 3D visualization applications, Diligent Engine is open-source and distributed
11+
under the permissive [Apache 2.0 license](License.txt).
1212

1313
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](License.txt)
1414
[![Chat on Discord](https://img.shields.io/discord/730091778081947680?logo=discord)](https://discord.gg/t7HGBK7)
1515
[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/DiligentGraphics/DiligentEngine?svg=true)](https://ci.appveyor.com/project/DiligentGraphics/diligentengine)
16+
[![Documentation](https://img.shields.io/badge/Documentation-blue)](https://diligentgraphics.github.io/docs)
1617

1718
## Supported Platforms and Low-Level Graphics APIs
1819

@@ -78,6 +79,7 @@ Minimum supported low-level API versions:
7879
* Vulkan 1.0
7980
* Metal 1.0
8081

82+
[**Documentation**](https://diligentgraphics.github.io/docs)
8183

8284
## High-level Rendering components
8385

@@ -1117,6 +1119,8 @@ on how to set up clang-format and automatic code formatting.
11171119
<a name="references"></a>
11181120
# References
11191121

1122+
[**Documentation**](https://diligentgraphics.github.io/docs)
1123+
11201124
[Coding Guidelines](https://github.com/DiligentGraphics/DiligentCore/blob/master/doc/CodingGuidelines.md)
11211125

11221126
[Performance Best Practices](https://github.com/DiligentGraphics/DiligentCore/blob/master/doc/PerformanceGuide.md)

0 commit comments

Comments
 (0)