Browse Source

meta: Add base project files

master
Jake Wakeling 2 months ago
commit
a70b8cf0c3
5 changed files with 82 additions and 0 deletions
  1. +5
    -0
      .gitignore
  2. +10
    -0
      BuildUNIX.sh
  3. +11
    -0
      CMakeLists.txt
  4. +27
    -0
      LICENCE
  5. +29
    -0
      README.md

+ 5
- 0
.gitignore View File

@@ -0,0 +1,5 @@
.clangd/
bin/
build/
compile_commands.json
lib/

+ 10
- 0
BuildUNIX.sh View File

@@ -0,0 +1,10 @@
#!/usr/bin/env sh
dir="$(dirname $(realpath "$0"))"

cmake -S "${dir}" -B "${dir}/build" \
-DCMAKE_BUILD_TYPE:STRING=Release \
-DCMAKE_EXPORT_COMPILE_COMMANDS=1

cmake --build "${dir}/build"

mv -f "${dir}/build/compile_commands.json" "${dir}/compile_commands.json"

+ 11
- 0
CMakeLists.txt View File

@@ -0,0 +1,11 @@
# CMakeLists.txt
# CMakeLists file for OMKOV cryptutils

CMAKE_MINIMUM_REQUIRED(VERSION 3.12)
PROJECT(cryptutils C)

SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/lib)
SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/lib)
SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/bin)

INCLUDE_DIRECTORIES(${PROJECT_SOURCE_DIR}/ext)

+ 27
- 0
LICENCE View File

@@ -0,0 +1,27 @@
OMKOV Permissive Licence, version 1.0

Copyright (C) 2020, Jakob Wakeling
All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal with
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:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimers.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimers in the documentation and/or
other materials provided with the distribution.
* Neither the names of the copyright holders, nor the names of its contributors
may be used to endorse or promote products derived from this Software without
specific prior written permission.

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 COPYRIGHT
HOLDERS OR CONTRIBUTORS 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 WITH THE SOFTWARE.

+ 29
- 0
README.md View File

@@ -0,0 +1,29 @@
# OMKOV cryptutils

> OMKOV implementations of cryptographic software utilities

OMKOV cryptutils implements many cryptographic utilities.

## Utilities

| Utility | Description | Standard |
| ---------------- | ---------------------------------------- | -------- |

## Build Instructions

OMKOV cryptutils uses CMake to build.
Binaries will be located in the `bin` directory.

### UNIX Build

Run `BuildUNIX.sh`, or

```sh
cmake -S . -B build && cmake --build build
```

## Meta

Copyright (C) 2020, Jakob Wakeling
All rights reserved.
[OMKOV Permissive Licence](https://www.omkov.net/OLPE)

Loading…
Cancel
Save