Skip to content

Commit

Permalink
update license info for ink! analyzer milestone 1
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidsemakula
davidsemakula committed May 9, 2023
1 parent fd1ce63 commit 56e89dc
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion deliveries/ink-analyzer-milestone-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Please see the [README](https://github.com/ink-analyzer/ink-analyzer#readme) for

| Number | Deliverable | Link | Notes |
|---------|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **0a.** | License | [Apache 2.0](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-APACHE) and [MIT](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-MIT). | |
| **0a.** | License | Dual-licensed under either of [MIT](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-MIT) or [Apache 2.0](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-APACHE) licenses at the library users' option. | |
| **0b.** | Documentation | [README](https://github.com/ink-analyzer/ink-analyzer#readme) on GitHub, rustdoc documentation on docs.rs for [semantic analyzer crate (ink-analyzer)](https://docs.rs/ink-analyzer/latest/ink_analyzer/), [IR crate (ink-analyzer-ir)](https://docs.rs/ink-analyzer-ir/latest/ink_analyzer_ir/), [proc-macro crate (ink-analyzer-macro)](https://docs.rs/ink-analyzer-macro/latest/ink_analyzer_macro/) and extensive inline source documentation in all 3 crates. | Each crate directory additionally includes a crate specific README (published on both GitHub - [here](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/analyzer), [here](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/ir) and [here](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/macro) - and crates.io - [here](https://crates.io/crates/ink-analyzer), [here](https://crates.io/crates/ink-analyzer-ir) and [here](https://crates.io/crates/ink-analyzer-macro)) that's targeted at library users and contains crate specific instructions for installation and usage and links to crate specific documentation on docs.rs. |
| **0c.** | Testing and Testing Guide | [Testing guide](https://github.com/ink-analyzer/ink-analyzer#testing). | See the diagnostics module doc for [methodology for extracting ink! semantic rules](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/analyzer/src/analysis/diagnostics.rs#L1-L18). References to the source of enforced semantic rules in the [ink_ir crate](https://github.com/paritytech/ink/blob/v4.1.0/crates/ink/ir/src/lib.rs) are included either in the rustdoc for most utilities or at the call site for more generic utilities. |
| **0d.** | Docker | [Dockerfile](https://github.com/ink-analyzer/ink-analyzer/blob/master/Dockerfile). | |
Expand Down

0 comments on commit 56e89dc

Please sign in to comment.