add license and readme
This commit is contained in:
22
LICENSE
Normal file
22
LICENSE
Normal file
@@ -0,0 +1,22 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Davide
|
||||
|
||||
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.
|
||||
|
||||
37
README.md
Normal file
37
README.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# CEV Skills for Claude Code
|
||||
|
||||
Support repository for office use of Claude Code, with ready-to-import skills to solve mechanical design and materials engineering questions.
|
||||
|
||||
## Goal
|
||||
- Provide modular skills (`SKILL.md`) for real engineering workflows.
|
||||
- Make Claude import easy through `.skill` and `.zip` packages.
|
||||
- Keep a single, versioned source of truth for skills, test prompts, and exports.
|
||||
|
||||
## Repository Structure
|
||||
- `skill/`: skill sources (one folder per skill, each with `SKILL.md`).
|
||||
- `script/`: automation tools (packaging and utilities).
|
||||
- `package/`: generated outputs (`per-skill/`, `bundles/`, package index).
|
||||
|
||||
## Packaging
|
||||
Generate import-ready packages for all skills:
|
||||
|
||||
```bash
|
||||
python3 script/package_skills.py
|
||||
```
|
||||
|
||||
Main outputs:
|
||||
- `package/per-skill/<skill-name>.skill`
|
||||
- `package/per-skill/<skill-name>.zip`
|
||||
- `package/bundles/mechanical-skills-collection.zip`
|
||||
- `package/PACKAGES_INDEX.md`
|
||||
|
||||
## Import in Claude
|
||||
- Single import: upload a file from `package/per-skill/`.
|
||||
- Internal distribution: use the `mechanical-skills-collection.zip` bundle.
|
||||
|
||||
## Operational Notes
|
||||
- Source skills live in `skill/`.
|
||||
- Files in `package/` are generated artifacts.
|
||||
|
||||
## License
|
||||
This project is released under the MIT License. See `LICENSE`.
|
||||
Reference in New Issue
Block a user