-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: document junobuild-macros and licenses (#425)
Signed-off-by: David Dal Busco <[email protected]>
- Loading branch information
1 parent
0835e57
commit f974a3a
Showing
6 changed files
with
899 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 David Dal Busco | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
## License | ||
|
||
`junobuild-macros` is available under dual licensing terms: | ||
|
||
- **MIT License**: For developers who are using the Juno platform in their projects. | ||
- **GNU Affero General Public License Version 3 (AGPLv3)**: For all other uses not involving the Juno platform. | ||
|
||
This dual licensing approach is designed to offer flexibility for Juno platform users while ensuring that the broader open-source community benefits from the AGPLv3's strong copyleft provisions. | ||
|
||
For more details, please see the [LICENSE-MIT] and [LICENSE-AGPL] files in the repository. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# JunoBuild-Shared | ||
|
||
`junobuild-macros` are procedural macros for hooking into various events in [Juno](https://juno.build). | ||
|
||
## Getting Started | ||
|
||
To include `junobuild-macros` in your Rust project, add it as a dependency in your `Cargo.toml`: | ||
|
||
```toml | ||
[dependencies] | ||
junobuild-macros = "*" | ||
``` | ||
|
||
Replace `"*"` with the specific version you want to use, or omit the version to always use the latest version. | ||
|
||
### Links & Resources | ||
|
||
Here are some useful links: | ||
|
||
- Looking to get started? Check out the [documentation](https://juno.build). | ||
- Have a look at the [LICENSE](https://github.com/junobuild/juno/blob/main/src/libs/macros/LICENSE.md) for information about licensing and limitation. | ||
- Have questions, comments or feedback? Join our [Discord](https://discord.gg/wHZ57Z2RAG) or [OpenChat](https://oc.app/community/vxgpi-nqaaa-aaaar-ar4lq-cai/?ref=xanzv-uaaaa-aaaaf-aneba-cai). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters