Skip to content

Commit

Permalink
[doc] use lower-case for doc files
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcelKoch committed Sep 16, 2024
1 parent 99c9dfe commit 8e517cc
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 15 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ The Ginkgo OMP module has the following __additional__ requirements:
* _MinGW_

In these environments, two problems can be encountered, the solution for which is described in the
[windows section in INSTALL.md](doc/user-guide/INSTALL.md#building-ginkgo-in-windows):
[windows section in install.md](doc/user-guide/install.md#building-ginkgo-in-windows):
* `ld: error: export ordinal too large` needs the compilation flag `-O1`
* `cc1plus.exe: out of memory allocating 65536 bytes` requires a modification of the environment

Expand All @@ -124,7 +124,7 @@ modules depending on your machine environment (present of CUDA, ...). You can
also explicitly compile with the OpenMP, CUDA, HIP or DPC++(SYCL) modules enabled to
run the examples with these executors.

Please refer to the [Installation page](doc/user-guide/INSTALL.md) for more details.
Please refer to the [Installation page](doc/user-guide/install.md) for more details.

Tip: After installation, in your CMake project, Ginkgo can be added with `find_package(Ginkgo)` and the the target that is exported is `Ginkgo::ginkgo`.
An example can be found in the [`test_install`](test/test_install/CMakeLists.txt).
Expand All @@ -144,7 +144,7 @@ Various examples are available for you to understand and play with Ginkgo within
A unique feature of Ginkgo is the ability to run benchmarks and view your results
with the help of the [Ginkgo Performance Explorer (GPE)](https://ginkgo-project.github.io/gpe/).

More details about this can be found in the [BENCHMARKING.md page](doc/user-guide/BENCHMARKING.md)
More details about this can be found in the [benchmarking.md page](doc/user-guide/benchmarking.md)

# Bug reports and Support

Expand All @@ -161,7 +161,7 @@ to the project are added under this license.

Depending on the configuration options used when building Ginkgo, third party
software may be pulled as additional dependencies, which have their own
licensing conditions. Refer to [ABOUT-LICENSING.md](doc/user-guide/ABOUT-LICENSING.md) for
licensing conditions. Refer to [about-licensing.md](doc/user-guide/about-licensing.md) for
details.

# Contributing to Ginkgo
Expand All @@ -185,7 +185,7 @@ license, as specified in the repository's LICENSE file.

#### Contribution Guidelines

When contributing to Ginkgo, to ease the review process, please follow the guidelines mentioned in [CONTRIBUTING.md](doc/user-guide/CONTRIBUTING.md).
When contributing to Ginkgo, to ease the review process, please follow the guidelines mentioned in [contributing.md](doc/user-guide/contributing.md).

It also contains other general recommendations such as writing proper commit messages, understanding Ginkgo's library design, relevant C++ information etc.

Expand Down Expand Up @@ -215,5 +215,4 @@ pages = {2:1--2:33}
}
```

For more information on topical subjects, please refer to the [CITING.md
page](doc/user-guide/CITING.md).
For more information on topical subjects, please refer to the [citing.md page](doc/user-guide/citing.md).
10 changes: 5 additions & 5 deletions doc/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# User Guide

This is the main page for the Ginkgo library user documentation. The repository is hosted on [github](https://github.com/ginkgo-project/ginkgo).
Documentation on aspects such as the build system, can be found at the [install page](user-guide/INSTALL.md).
Documentation on aspects such as the build system, can be found at the [install page](user-guide/install.md).
The {doxy}`Examples` can help you get started with using Ginkgo.

The Ginkgo library can be grouped into modules which form the basic building blocks of Ginkgo. The modules can be summarized as follows:
Expand All @@ -24,10 +24,10 @@ The Ginkgo library can be grouped into modules which form the basic building blo

Tutorial <https://github.com/ginkgo-project/ginkgo/wiki/Tutorial:-Building-a-Poisson-Solver>
Examples <_doxygen/html/Examples.html#https://>
Publications <user-guide/CITING>
user-guide/CONTRIBUTING
Using Ginkgo <user-guide/INSTALL>
user-guide/ABOUT-LICENSING
Publications <user-guide/citing>
user-guide/contributing
Using Ginkgo <user-guide/install>
user-guide/about-licensing
API <_doxygen/html/index.html#https://>
:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ For detecting the HWLOC library, we used a modified version of the FindHWLOC.cma
__NOTE:__ Some of the options that pull additional software when compiling
Ginkgo are ON by default, and have to be disabled manually to prevent
third-party licensing. Refer to the [Installation section in
INSTALL.md](INSTALL.md#building) for more details.
install.md](install.md#building) for more details.


When using testing with MPI switched on, the gtest-mpi-listener header only library is used for testing MPI functionality. The repository is licensed triple licensed under BSD-3, MIT and Apache 2.0. The License duplicated below. More details on the License and the library are [available on github](https://github.com/LLNL/gtest-mpi-listener)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions doc/user-guide/INSTALL.md → doc/user-guide/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,6 @@ An example can be found in the [`test_install`](../../test/test_install/CMakeLis
:::{toctree}
:hidden:
self
TESTING
BENCHMARKING
testing
benchmarking
:::
File renamed without changes.

0 comments on commit 8e517cc

Please sign in to comment.