Skip to content

Commit f8ef3ad

Browse files
committed
docs: add release document
1 parent 2a8c863 commit f8ef3ad

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/RELEASE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Release Document
2+
3+
## Preparation
4+
5+
In order to release a new version of Ada, please update the
6+
following documents:
7+
8+
- [CmakeLists.txt](../CmakeLists.txt)
9+
- [Doxygen](../doxygen)
10+
- [ada-version.h](../include/ada/ada-version.h)
11+
12+
## Release
13+
14+
- Run amalgation script using `./singleheader/amalgamate.py`
15+
- Create a Github release with following format: `v1.0.0`
16+
- Upload the following documents to the release
17+
- `./singleheader/ada.h`
18+
- `./singleheader/ada.cpp`
19+
- `./singleheader/singleheader.zip`

0 commit comments

Comments
 (0)