wire/README.md
Vurv 3764d10f6b
Add canary to readme (#2904)
Parity with wiki
2023-11-24 16:39:25 -08:00

36 lines
2.2 KiB
Markdown

# Wiremod [![License](https://img.shields.io/github/license/wiremod/wire?color=red)](LICENSE) [![Discord](https://img.shields.io/discord/231131817640460288?label=Discord&logo=discord&logoColor=ffffff&labelColor=7289DA&color=2c2f33)](https://discord.gg/H8UKY3Y) [![Workshop](https://img.shields.io/steam/subscriptions/160250458?logo=steam)](https://steamcommunity.com/sharedfiles/filedetails/?id=160250458)
> An addon for [Garry's Mod](https://garrysmod.com) which adds entities that communicate via wires. It can be used to create robots, vehicles, computers and much more!
## ⬇️ Installation
| Addon | Workshop | GitHub |
| --- | --- | --- |
|**Wiremod** (Stable) | [![Wiremod](https://img.shields.io/steam/subscriptions/160250458?logo=steam)](https://steamcommunity.com/sharedfiles/filedetails/?id=160250458) | https://github.com/wiremod/wire |
|**Wiremod** (Canary) | [![Wiremod Canary](https://img.shields.io/steam/subscriptions/3066780663?logo=steam&color=orange)](https://steamcommunity.com/sharedfiles/filedetails/?id=3066780663) | https://github.com/wiremod/wire |
|**AdvDupe2**| [![AdvDupe2](https://img.shields.io/steam/subscriptions/773402917?logo=steam)](https://steamcommunity.com/sharedfiles/filedetails/?id=773402917)| https://github.com/wiremod/advdupe2 |
|**Wire Extras**| [None yet](https://github.com/wiremod/wire-extras/issues/113) | https://github.com/wiremod/wire-extras |
For git, inside of `steamapps/common/Garrysmod/garrysmod/addons`, run ``git clone https://github.com/wiremod/wire``.
## 📖 Documentation
You can find documentation [on our wiki](https://github.com/wiremod/wire/wiki)!
## 🤝 Contributing
> Before contributing to wiremod, take a look at the [code of conduct](https://github.com/wiremod/wire/blob/master/CODE_OF_CONDUCT.md).
### 💡 Suggestions
To submit a suggestion, [use the discussions page](https://github.com/wiremod/wire/discussions/new?category=suggestions).
### 🐛 Bug Reports
To submit a bug report, [make an issue](https://github.com/wiremod/wire/issues/new/choose).
### 🧑‍💻 Pull Requests
Before making a PR, ensure your code follows the [developer style guide](https://github.com/wiremod/wire/wiki/Developer-Style-Guide).