Skip to content

Commit aae68f6

Browse files
committed
Update readme, changelog in preparation for 0.1.0
1 parent 491714e commit aae68f6

File tree

2 files changed

+30
-19
lines changed

2 files changed

+30
-19
lines changed

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic
7+
Versioning](http://semver.org/spec/v2.0.0.html).
8+
9+
## [Unreleased]
10+
11+
## [0.1.0] - 2019-09-05
12+
13+
__Hello, World!__ This is our first release!
14+

README.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Celerity Runtime
1+
![Celerity Logo](docs/celerity_logo.png)
2+
3+
# Celerity Runtime - [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/celerity/celerity-runtime/blob/master/LICENSE) [![Semver 2.0](https://img.shields.io/badge/semver-2.0.0-blue)](https://semver.org/spec/v2.0.0.html) [![PRs # Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/celerity/celerity-runtime/blob/master/CONTRIBUTING.md)
24

35
The Celerity distributed runtime and API aims to bring the power and ease of
46
use of SYCL to distributed memory clusters.
@@ -11,28 +13,18 @@ projects in the future.
1113

1214
## Dependencies
1315

14-
* [Boost](http://www.boost.org) (tested with version 1.65 - 1.68)
1516
* A supported SYCL implementation, either
1617
- [hipSYCL](https://github.com/illuhad/hipsycl), or
1718
- [ComputeCpp](https://www.codeplay.com/products/computesuite/computecpp)
19+
* [Boost](http://www.boost.org) (tested with version 1.65 - 1.68)
1820
* A MPI 2 implementation (tested with OpenMPI 4.0 and MSMPI 10.0)
1921
* [CMake](https://www.cmake.org)
20-
* A C++14 compiler (tested with MSVC 14, gcc 7 and Clang 8)
21-
22-
### Automatically Downloaded Dependencies
23-
24-
These dependencies are downloaded automatically during the CMake build process,
25-
for convenience:
26-
27-
* [Catch2](https://github.com/catchorg/Catch2) for testing
28-
* The [spdlog](https://github.com/gabime/spdlog) logging library
22+
* A C++14 compiler
2923

3024
## Building
3125

32-
Building is as simple as calling `cmake && make`, depending on your setup you
33-
might however also have to provide some library paths etc.
34-
35-
## Building Examples
26+
Building can be as simple as calling `cmake && make`, depending on your setup
27+
you might however also have to provide some library paths etc.
3628

3729
The runtime comes with several examples that are built automatically when
3830
the `CELERITY_BUILD_EXAMPLES` CMake option is set (true by default).
@@ -44,9 +36,13 @@ relevant header files and libraries to the `CMAKE_INSTALL_PREFIX`. This includes
4436
a CMake [package configuration
4537
file](https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#package-configuration-file)
4638
which is placed inside the `lib/cmake` directory. Once included in a CMake
47-
project, you can use the
48-
`add_celerity_to_target(TARGET target SOURCES source1 source2...)` function to
49-
set everything up.
39+
project, you can use the `add_celerity_to_target(TARGET target SOURCES source1
40+
source2...)` function to set everything up.
41+
42+
## Running a Celerity Application
43+
44+
Celerity is built on top of MPI, which means a Celerity application can be
45+
executed like any other MPI application (i.e., using `mpirun` or equivalent).
5046

5147
## Environment Variables
5248

@@ -58,4 +54,5 @@ set everything up.
5854
* `CELERITY_PROFILE_OCL` controls whether OpenCL-level profiling information
5955
should be used or not (currently not supported when using hipSYCL).
6056
* `CELERITY_LOG_LEVEL` controls the logging output level. One of `trace`, `debug`,
61-
`info`, `warn`, `err`, `critical`, or `off`.
57+
`info`, `warn`, `err`, `critical`, or `off`.
58+

0 commit comments

Comments
 (0)