This repository has no description
docs: update readme
author
Kieran Klukas
date
(Mar 15, 2025, 2:01 PM -0400)
commit
db76e47b
db76e47bbce5ff3b9844d7135ac1253d3f7d47b2
parent
25b4209e
25b4209e72efde28c2fd5ae118ad812cae7b04ab
+15
-24
+15
-24
README.md
+15
-24
README.md
···
1
1
<h1 align="center">
2
-
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/carriage.webp" width="200" alt="Logo"/><br/>
3
-
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/transparent.png" height="45" width="0px"/>
4
-
<span>Carriage</span>
5
-
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/transparent.png" height="30" width="0px"/>
2
+
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/main/.github/images/carriage.webp" width="200" alt="Logo"/><br/>
3
+
<span>Myrus</span>
6
4
</h1>
7
5
8
6
<p align="center">
9
-
<i>A train carriage can be anything you want it to be and is a container for storing things so that seems like an appropriate name</i>
7
+
<i>A project for scrapyard</i>
10
8
</p>
11
9
12
10
<p align="center">
13
-
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/line-break-thin.svg" />
11
+
<img src="https://raw.githubusercontent.com/taciturnaxolotl/myrus/master/.github/images/line-break-thin.svg" />
14
12
</p>
15
13
16
-
## What's this?
14
+
## pins
17
15
18
-
This is my personal template repo! It serves as the reference for my `README.md` formating style and ~~hopefully soon my license scheme~~.
19
-
20
-
## Why that License?
21
-
22
-
Well I like using the AGPL 3.0 license because it's a strong copyleft license that ensures that any changes made to the code are shared back with the community. However there is often alot of confusion about how the license works. Here are 3 brief cases showing how the AGPL 3.0 license works:
23
-
24
-
1. You download the binary from the releases or use a hosted version.
25
-
- You haven't done anything to the code so you are entirely in the clear!
26
-
2. You see a problem with the code so you fork it and use it privately
27
-
- You are still in the clear! The AGPL 3.0 license only requires you to share the code if you distribute it.
28
-
3. You find an improvement, implement it, and distribute it privately in your company or for some family and friends
29
-
- You are still in the clear! The AGPL 3.0 license only requires you to share the code if you distribute it to the public.
30
-
31
-
Basically if you distribute the code publicaly you have to share the code, but if you don't distribute the code publicaly or don't modify it then you don't have to share the code.
16
+
1. `D6 (PIN_SERVO)` - Servo motor control
17
+
2. `D10 (motor1StepPin)` - Step signal for Motor 1
18
+
3. `D9 (motor1DirPin)` - Direction control for Motor 1
19
+
4. `D8 (motor2StepPin)` - Step signal for Motor 2
20
+
5. `D7 (motor2DirPin)` - Direction control for Motor 2
21
+
6. `D1 (enablePin)` - Enable/disable control for both motors
22
+
7. `PIN_LED` - LED indicator (pin number not specified in the code snippet)
32
23
33
24
<p align="center">
34
-
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/line-break.svg" />
25
+
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/main/.github/images/line-break.svg" />
35
26
</p>
36
27
37
28
<p align="center">
38
-
<i><code>© 2024-present <a href="https://github.com/taciturnaxolotl">Kieran Klukas</a></code></i>
29
+
<i><code>© 2025-present <a href="https://github.com/taciturnaxolotl">Kieran Klukas, Payton Curry, and Elizabeth Klukas</a></code></i>
39
30
</p>
40
31
41
32
<p align="center">
42
-
<a href="https://github.com/taciturnaxolotl/carriage/blob/master/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=AGPL 3.0&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
33
+
<a href="https://github.com/taciturnaxolotl/myrus/blob/master/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=AGPL 3.0&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
43
34
</p>