Skip to content

Commit

Permalink
meta: update license and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
theacodes committed Feb 3, 2024
1 parent 5f3abbb commit 472ddb7
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
16 changes: 9 additions & 7 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
# Winterbloom Neptune and Copyright Notices
# Winterbloom Neptune License and Copyright Notices

Neptune is (c) 2023 by Winterbloom / Alethea Katherine Flowers
Neptune is (c) 2024 by Winterbloom LLC, Alethea Katherine Flowers, and Carson Walls

This notice must be included in any distributions of this project or
derivative works.

Since this project consists of hardware, documentation, and designs,
individual parts of the project are made available under different licenses.

1. The functional hardware designs located at `./hardware` are available under
1. The factory setup scripts located at `./factory` are available under the MIT
license. Full text available at https://opensource.org/licenses/MIT
2. The functional hardware designs located at `./hardware` are available under
the CERN-OHL-P v2 license. Full text is available at https://cern.ch/cern-ohl.
4. The panel design located at `./hardware/panel` is available under Creative
3. The panel design located at `./hardware/panel` is available under Creative
Commons Attribution-ShareAlike 4.0 International
(CC BY-SA 4.0). Full text available at
https://creativecommons.org/licenses/by-sa/4.0/
5. The user's guide located at `./user_guide` is available under Creative
4. The user's guide located at `./user_guide` is available under Creative
Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0). Full
text available at https://creativecommons.org/licenses/by-sa/4.0/
6. Winterbloom's logo and branding is used throughout this project. This
branding is Copyright (c) Winterbloom / Alethea Katherine Flowers 2020 and
5. Winterbloom's logo and branding is used throughout this project. This
branding is Copyright (c) Winterbloom LLC / Alethea Katherine Flowers 2020 and
all rights are reserved. You may not distribute derivative works or products
bearing the Winterbloom logo. Derivative works should remove Winterbloom
branding.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Winterbloom ?
# Winterbloom Neptune

Neptune
Neptune is a *salty* diode ladder filter.

More details available at https://winterbloom.com/shop/?
More details available at https://winterbloom.com/shop/neptune

## Repository layout

This repository contains the hardware design files and user guide for Neptune:

- **factory/** contains the scripts used to program, test, and calibrate the module after assembly. These scripts are all written in Python.
- **hardware/** contains the hardware design files for the mainboard and blank panel, as well as hardware for automated testing. These are all created using KiCAD.
- **factory/** contains the required data for manufacturing, including gerber files, testing, etc.
- **user_guide/** contains the user's guide source files. These are written in Markdown and published using MkDocs.
- **simulation/** contains the simulation used to design this filter. These should be opened using the Falstad CircuitJS simulator https://www.falstad.com/circuit/circuitjs.html.

Expand Down
Binary file removed hardware/board.zip
Binary file not shown.

0 comments on commit 472ddb7

Please sign in to comment.