wiremod/wire
1
0
Fork 0
mirror of https://github.com/wiremod/wire.git synced 2025-03-04 03:03:04 -05:00
Code Issues Packages Projects Releases Wiki Activity

New README.md (#2650)

Browse Source
This commit is contained in:
Vurv 2023-06-26 11:36:44 -07:00 committed by GitHub
parent db35c14e93
commit 5b0fa85b78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -1,6 +1,6 @@
# Coding Guidelines
Please see https://github.com/wiremod/wire/wiki/Coding-style for information on how code formatting is standardized in the Wiremod project.
Please see https://github.com/wiremod/wire/wiki/Developer-Style-Guide for information on how code formatting is standardized in the Wiremod project.
---

41
README.md
View File

@ -1,37 +1,34 @@
# Wiremod
# 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)
Wiremod is a [Garry's Mod][] addon which adds entities that communicate via data wires. It can be used to control robots, vehicles, to make computers inside Garry's Mod, and much more!
> 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!
# Workshop Installation
## ⬇️ Installation
The Wiremod Collection is available on the Steam Workshop! Go to the [Workshop page][WireTeam Workshop Collection] and press `Subscribe` on the addons you want
| Addon | Workshop | GitHub |
| --- | --- | --- |
|**Wiremod**| [![Wiremod](https://img.shields.io/steam/subscriptions/160250458?logo=steam)](https://steamcommunity.com/sharedfiles/filedetails/?id=160250458) | https://github.com/wiremod/wire |
|**AdvDupe2**| [![AdvDupe2](https://img.shields.io/steam/subscriptions/160250458?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 |
# Manual Installation
For git, inside of `steamapps/common/Garrysmod/garrysmod/addons`, run ``git clone https://github.com/wiremod/wire``.
Clone this repository into your `steamapps\common\GarrysMod\garrysmod\addons` folder using this command if you are using git:
## 📖 Documentation
git clone https://github.com/wiremod/wire.git wire
You can find documentation [on our wiki](https://github.com/wiremod/wire/wiki)!
# License
Copyright 2008 onwards by the Wire Team
## 🤝 Contributing
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
> Before contributing to wiremod, take a look at the [code of conduct](CODE_OF_CONDUCT.md).
http://www.apache.org/licenses/LICENSE-2.0
### 💡 Suggestions
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
To submit a suggestion, [use the discussions page](https://github.com/wiremod/wire/discussions/new?category=suggestions).
# Links
### 🐛 Bug Reports
[Garry's Mod]: <http://garrysmod.com/>
To submit a bug report, [make an issue](https://github.com/wiremod/wire/issues/new/choose).
[WireTeam Workshop Collection]: <https://steamcommunity.com/id/wireteam/myworkshopfiles/?appid=4000>
### 🧑‍💻 Pull Requests
[Wiremod landing page](http://wiremod.com)
[Wiremod Official Discord](https://discord.gg/H8UKY3Y)
# Contributor Guidelines
See CONTRIBUTING.md for guidelines on contributing and participating in the wiremod project.
Before making a PR, ensure your code follows the [developer style guide](https://github.com/wiremod/wire/wiki/Developer-Style-Guide).