Skip to content

Commit b74f260

Browse files
committed
docs: add custom hexagon logo, badges, changelog, and license to package
1 parent 8c0c8d7 commit b74f260

5 files changed

Lines changed: 111 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.1.0] - 2026-05-23
9+
10+
### Added
11+
- Initial release of `CrucibleTensorPatch` under the TRINITY decomposition.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2026 North Shore AI
3+
Copyright (c) 2026 North-Shore-AI
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
1+
<p align="center">
2+
<img src="assets/crucible_tensor_patch.svg" alt="CrucibleTensorPatch Logo" width="120px" />
3+
</p>
4+
15
# CrucibleTensorPatch
26

7+
<p align="center">
8+
<a href="https://github.com/North-Shore-AI/crucible_tensor_patch/actions/workflows/ci.yml">
9+
<img src="https://github.com/North-Shore-AI/crucible_tensor_patch/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI Status" />
10+
</a>
11+
<a href="https://github.com/North-Shore-AI/crucible_tensor_patch/blob/main/LICENSE">
12+
<img src="https://img.shields.io/github/license/North-Shore-AI/crucible_tensor_patch" alt="GitHub License" />
13+
</a>
14+
</p>
15+
316
Deterministic tensor patch plans and patch application for model surgery.
417

518
The package owns generic patch behavior: plan parsing, tensor path traversal,

assets/crucible_tensor_patch.svg

Lines changed: 84 additions & 0 deletions
Loading

mix.exs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ defmodule CrucibleTensorPatch.MixProject do
7272
defp docs do
7373
[
7474
main: "readme",
75-
extras: ["README.md", "MIGRATION.md"],
75+
extras: ["README.md", "CHANGELOG.md", "MIGRATION.md", "LICENSE"],
7676
source_ref: "main",
7777
source_url: @source_url,
7878
homepage_url: @source_url
@@ -84,7 +84,7 @@ defmodule CrucibleTensorPatch.MixProject do
8484
name: "crucible_tensor_patch",
8585
licenses: ["MIT"],
8686
links: %{"GitHub" => @source_url},
87-
files: ~w(lib build_support mix.exs README.md LICENSE MIGRATION.md)
87+
files: ~w(lib build_support mix.exs README.md LICENSE CHANGELOG.md MIGRATION.md)
8888
]
8989
end
9090
end

0 commit comments

Comments
 (0)