From 4850d4346dadbbb249aecb2c39ded572cd3d1948 Mon Sep 17 00:00:00 2001
From: Toad-Dev <748280+Toad-Dev@users.noreply.github.com>
Date: Tue, 7 Dec 2021 14:01:34 -0800
Subject: [PATCH] Fix typos, tighten up README.
---
README.md | 38 +++++++++++++++-----------------------
1 file changed, 15 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index 3d9421ad2..f8e2d36ef 100644
--- a/README.md
+++ b/README.md
@@ -2,21 +2,25 @@
[](https://github.com/cc-tweaked/cc-restitched/actions "Current build status")
[](https://www.curseforge.com/minecraft/mc-mods/cc-restitched "Download CC: Restitched on CurseForge")
-[](https://gitpod.io/#https://github.com/cc-tweaked/cc-restitched/tree/1.17)
+[](https://gitpod.io/#https://github.com/cc-tweaked/cc-restitched/tree/1.17.1)
-# CC: R Version VS CC: T Version
-CC: R Strives to maintain perfect pairity with CC: T, however in some cases this is not possible, so CC: R might have a "newer" version than what CC: T has, these newer versions will be primarily bugfixes and the like because [Fabric](https://fabricmc.net/) is "weird" when porting a Forge mod.
+# What is CC: Restitched?
+This is a fabric port of [SquidDev-CC/CC-Tweaked](https://github.com/SquidDev-CC/CC-Tweaked). The work is a continuation of [Zundrel/cc-tweaked-fabric](https://github.com/Zundrel/cc-tweaked-fabric).
-## What is CC: Restiched
-This is an fork of [Zundrel/cc-tweaked-fabric](https://github.com/Zundrel/cc-tweaked-fabric) who's goal was to port [SquidDev-CC/CC-Tweaked](https://github.com/SquidDev-CC/CC-Tweaked) to the [Fabric](https://fabricmc.net/) modloader. I picked up maintaining the mod because the team working on Zundrel's fork can no longer mantain it so, I picked it up to make it as equal as possible with CC: T.
+## CC: Restitched vs. CC: Tweaked
+CC: R tries to maintain parity with CC: T, but may be behind or divergent in some areas. If you notice a disparity please open an issue. CC: R major and minor version numbers indicate parity with the major features of that version of CC: T. Patch version numbers will not align.
## Resource Packs
-This mod includes textures that are more in-line with the style of Mojang's new texture-artist, Jappa. If you prefer the original textures, enable the "Classic" resource pack.
+This mod includes textures by [Jummit](https://github.com/Jummit) that are more in line with the style of Mojang's new texture-artist, Jappa. If you prefer the original textures, enable the "Classic" resource pack.
-
[3prm3/cc-pack](https://github.com/3prm3/cc-pack/)
-We also have a second resourcepack made by [3prm3](https://github.com/3prm3), it features a complete overhaul and can be enabled by enabling the `overhaul` resource pack, go check out his resource pack over here!
+ We also have a second resourcepack made by [3prm3](https://github.com/3prm3), it features a complete overhaul and can be enabled by enabling the `overhaul` resource pack, go check out his resource pack over [here](https://github.com/3prm3/cc-pack/)!
-# Does this work with shaders/[Sodium?](https://github.com/CaffeineMC/sodium-fabric)
+## Contributing
+Any contribution is welcome, be that using the mod, reporting bugs or contributing code. In order to start helping develop CC: R there are a few rules;
+1) Make sure your code follows the checkstyle rules. You can test this by running `./gradle build` or `./gradle check`.
+2) Do not alter the lua code unless those changes are taken directly from CC: Tweaked. If you wish to contribute changes to the in game rom please contribute upstream at [CC-Tweaked](https://github.com/SquidDev-CC/CC-Tweaked).
+
+# Does this work Fabric's many rendering mods?
* [ YES ] Sodium
* [ YES ] Optifine
* Works with VBO Rendering (automatically set)
@@ -58,17 +62,5 @@ Bleeding edge builds can be found [here](https://github.com/cc-tweaked/cc-restit
## Community
If you need help getting started with CC: Restitched, want to show off your latest project, or just want to chat about ComputerCraft, here is the [Forum](https://forums.computercraft.cc/) and the [Discord](https://discord.gg/H2UyJXe).
-## Known Bugs/Issues
-Main Known issue
-* Mods that add blocks that can be used as peripherals for CC: T on Forge, don't work with CC: R.
- * This is because of the differences between Forge and [Fabric](https://fabricmc.net/), and that mod devs, to my knowledge have not agreed upon a standard method in which to implement cross compatibility between mods,
-* Occasionally a computer will say "File not found" when running a built in program, this is normal just hold `crtl+r` to reboot it.
- * We do not know what causes it directly, however it happens when the world is `/reload`ed, and currently running programs are not affected so nothing *should break*
-
-## Perpherals
-Unfortunately, unlike the original CC: Tweaked project, CC: Restitched, does not have any actual peripheral mods, currently the only one we have is an example for mod devs to get started with making/adding the peripheral API to their mods!
-
-If you're a mod dev, made a mod with CC: R peripheral support OR if you're a player who found a mod with CC: R support, please open an [issue here](https://github.com/cc-tweaked/cc-restitched/issues/new?assignees=&labels=peripheralShoutout&template=peripheral_shoutout.md) to let us know so we can add it to the list!
-
-*  [CC Peripheral Test [1.16.5]](https://github.com/Toad-Dev/cc-peripheral-test)
- * This is an example mod for how to make peripherals that work as a block, or as a turtle upgrade!
+## Perpheral mods
+Unfortunately, CC: Restitched does not have as many peripherals mods available as CC: Tweaked. If you're an interested mod developer, please check out our `api` package. If you've already made a mod with CC: R peripheral support OR if you're a player who found a mod with ComputerCraft integration, please open an [issue here](https://github.com/cc-tweaked/cc-restitched/issues/new?assignees=&labels=peripheralShoutout&template=peripheral_shoutout.md) to let us know and we'll add it to the list!