README should be at root to display in github main page.
Also, removed paragraph related to API changes early
in development.

Change-Id: I2e92573a31d3caa7790364de9356c6d7e7be553d
Этот коммит содержится в:
Chris Freehill
2020-08-06 09:09:51 -05:00
родитель 0468aa4971
Коммит da64e284dc
3 изменённых файлов: 2 добавлений и 7 удалений
-5
Просмотреть файл
@@ -3,11 +3,6 @@
The ROCm System Management Interface Library, or ROCm SMI library, is part of the Radeon Open Compute [ROCm](https://github.com/RadeonOpenCompute) software stack . It is a C library for Linux that provides a user space interface for applications to monitor and control GPU applications.
# Important note about Versioning and Backward Compatibility
The ROCm SMI library is currently under development, and therefore subject to change either at the ABI or API level. The intention is to keep the API as stable as possible even while in development, but in some cases we may need to break backwards compatibility in order to ensure future stability and usability. Following [Semantic Versioning](https://semver.org/) rules, while the ROCm SMI library is in high state of change, the major version will remain 0, and backward compatibility is not ensured.
Once new development has leveled off, the major version will become greater than 0, and backward compatibility will be enforced between major versions.
# Building ROCm SMI
#### Additional Required software for building
+1 -1
Просмотреть файл
@@ -147,7 +147,7 @@ if (DOXYGEN_FOUND AND LATEX_FOUND)
add_dependencies(${ROCM_SMI_TARGET} docs)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf
DESTINATION ${ROCM_SMI}/docs/${RSMI_MANUAL_NAME}.pdf)
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/docs/README.md
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/../README.md
DESTINATION ${ROCM_SMI}/docs/)
else()
message("Doxygen or Latex is not found. Will not generate documents.")
+1 -1
Просмотреть файл
@@ -758,7 +758,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = @CMAKE_CURRENT_SOURCE_DIR@/docs/README.md \
INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../README.md \
@CMAKE_CURRENT_SOURCE_DIR@/../include/rocm_smi/rocm_smi.h
# This tag can be used to specify the character encoding of the source files