Skip to content

Commit

Permalink
docs: list third party embedded libs, list licenses, ref #204
Browse files Browse the repository at this point in the history
  • Loading branch information
iboB committed Nov 22, 2024
1 parent 677add3 commit 3f7455a
Show file tree
Hide file tree
Showing 7 changed files with 146 additions and 2 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Contributing to AC Local

*TBD*
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,5 @@ Copyright © 2024 [Alpaca Core, Inc](https://github.com/alpaca-core)
## Third Party Libraries
[A list of the third party libraries used here](third-party.md). Please consider supporting them.
Additionally, if you deploy this software as binary, please include `etc/ac-local-deploy-licenses.md` in your deployment.
22 changes: 22 additions & 0 deletions astl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,25 @@
C++ header-only libraries which are mostly STL extensions.

No external dependencies are allowed. If needed, copy the code from the external library here.

## Copied files

The following files were copied from external repositories:

* [iboB/splat](https://github.com/iboB/itlib):
* `pp_select.h`
* `symbol_export.h`
* [iboB/itlib](https://github.com/iboB/itlib), namespace changed from `itlib` to `astl`:
* `flat_map.hpp`
* `generator.hpp`
* `mem_streambuf.hpp`
* `qalgorithm.hpp`
* `sentry.hpp`
* `small_vector.hpp`
* `throw_ex.hpp`
* `time_t.hpp`
* `ufunction.hpp`

# Why embed?

The reason for embedding instead of using it as a package can be found [here](https://github.com/alpaca-core/ac-local/issues/177#issuecomment-2456690091)
10 changes: 9 additions & 1 deletion dict/code/ac/vendor/nlohmann/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
A copy of [nlohmann/json 3.11.3](https://github.com/nlohmann/json/tree/v3.11.3/single_include/nlohmann) with the following changes:
# nlohmann/json

A copy of [nlohmann/json 3.11.3](https://github.com/nlohmann/json/tree/v3.11.3/single_include/nlohmann)

## Changes

* namespace `nlohmann` renamed to `acnl`
* JSON_DISABLE_ENUM_SERIALIZATION is 1 by default

## Why embed?

The reason for embedding instead of using it as a package can be found [here](https://github.com/alpaca-core/ac-local/issues/177#issuecomment-2454378703)
97 changes: 97 additions & 0 deletions etc/ac-local-deploy-licenses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Alpaca Core Local SDK Licenses

## alpaca-core/ac-local

Copyright (c) 2024 Alpaca Core

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 above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

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.

## nlohmann/json

MIT License

Copyright (c) 2013-2022 Niels Lohmann

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 above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

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.

## iboB/jalog iboB/splat

MIT License

Copyright (c) 2020-2024 Borislav Stanimirov

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 above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

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.

## iboB/itlib

MIT License

Copyright (c) 2016-2019 Chobolabs Inc.

Copyright (c) 2020-2024 Borislav Stanimirov

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 above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

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.
12 changes: 12 additions & 0 deletions jalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Jalog

This an almost exact copy of the original [Jalog](https://github.com/iboB/jalog)

## Changes

* Namespace changed from `jalog` to `ac::jalog`
* Async logging removed

## Why embed?

The reason for embedding instead of using it as a package can be found [here](https://github.com/alpaca-core/ac-local/issues/177#issuecomment-2456690091)
2 changes: 1 addition & 1 deletion third-party.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ Here's the list in no particular order:
| --- | --- |
| [CPM.cmake](https://github.com/TheLartians/CPM.cmake) | package management |
| [iboB's CMake Modules](https://github.com/iboB/splat) | CMake modules |
| [doctest](https://github.com/onqtam/doctest) | testing |
| [doctest](https://github.com/doctest/doctest) | testing |
| [doctest-util](https://github.com/iboB/doctest-util) | testing |

0 comments on commit 3f7455a

Please sign in to comment.