Skip to content

Commit

Permalink
docs: fill project information from template (#3)
Browse files Browse the repository at this point in the history
* docs: replace license with MIT license

* docs: fill `README.md` file content

* build: fill `CMakeLists.txt`
  • Loading branch information
threeal authored Apr 19, 2024
1 parent 20559ef commit c138f63
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 40 deletions.
14 changes: 7 additions & 7 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
cmake_minimum_required(VERSION 3.19)

project(
MyMkdir
SetupGo
VERSION 0.0.0
DESCRIPTION "A starter CMake package for creating directories recursively"
HOMEPAGE_URL https://github.com/threeal/cmake-starter
DESCRIPTION "Set up a specific version of Go from a CMake project"
HOMEPAGE_URL https://github.com/threeal/setup-go-cmake
LANGUAGES NONE
)

Expand All @@ -25,15 +25,15 @@ if(NOT SUBPROJECT)

include(CMakePackageConfigHelpers)
write_basic_package_version_file(
MyMkdirConfigVersion.cmake
SetupGoConfigVersion.cmake
COMPATIBILITY SameMajorVersion
)

install(
FILES
cmake/MkdirRecursive.cmake
cmake/MyMkdirConfig.cmake
${CMAKE_CURRENT_BINARY_DIR}/MyMkdirConfigVersion.cmake
DESTINATION lib/cmake/MyMkdir
cmake/SetupGoConfig.cmake
${CMAKE_CURRENT_BINARY_DIR}/SetupGoConfigVersion.cmake
DESTINATION lib/cmake/SetupGo
)
endif()
37 changes: 17 additions & 20 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
This is free and unencumbered software released into the public domain.
MIT License

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
Copyright (c) 2024 Alfi Maulana

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

For more information, please refer to <http://unlicense.org/>
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
<!-- Clear the content of this file and replace it with the description of your project. -->
<!-- Learn more: https://www.makeareadme.com -->
# SetupGo.cmake

# CMake Starter
Set up a specific version of [Go](https://go.dev/) from a [CMake](https://cmake.org/) project.

The CMake Starter is a [GitHub repository template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) that provides a minimalistic boilerplate to kickstart your [CMake](https://cmake.org/) project.
This template offers a streamlined foundation, complete with predefined file structures, essential tools, and recommended settings, ensuring a swift and efficient start to your CMake development journey.
## License

## Key Features
This project is licensed under the terms of the [MIT License](./LICENSE).

- Standard template for CMake projects supporting installation and testing of CMake modules.
- Automated CI with [GitHub Actions](https://github.com/features/actions) workflows for building and testing the CMake project.
- [Dependabot](https://docs.github.com/en/code-security/dependabot) integration for checking updates on GitHub Actions dependencies.

## Usage

Refer to [this wiki](https://github.com/threeal/cmake-starter/wiki) for information on how to use this template.
Copyright © 2024 [Alfi Maulana](https://github.com/threeal)
File renamed without changes.

0 comments on commit c138f63

Please # to comment.