mirror of
				https://github.com/SquidDev-CC/CC-Tweaked
				synced 2025-10-31 13:42:59 +00:00 
			
		
		
		
	Some README cleanup
- Standardise our badges a little, adding a modrinth badge. - Mention Fabric and Forge support. - Don't include MC version in the Modrinth version number. I feel this was required at some point, but apparently not any more! This also allows us to use Modrinth for the Forge update JSON.
This commit is contained in:
		
							
								
								
									
										14
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								README.md
									
									
									
									
									
								
							| @@ -5,13 +5,15 @@ SPDX-License-Identifier: MPL-2.0 | |||||||
| --> | --> | ||||||
| 
 | 
 | ||||||
| #  | #  | ||||||
| [](https://github.com/cc-tweaked/CC-Tweaked/actions "Current build status") [][CurseForge] | [](https://github.com/cc-tweaked/CC-Tweaked/actions "Current build status") | ||||||
|  | [][CurseForge] | ||||||
|  | [][Modrinth] | ||||||
| 
 | 
 | ||||||
| CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game. A fork of the | CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game. A fork of the | ||||||
| much-beloved [ComputerCraft], it continues its legacy with better performance, stability, and a wealth of new features. | much-beloved [ComputerCraft], it continues its legacy with improved performance and stability, along with a wealth of | ||||||
|  | new features. | ||||||
| 
 | 
 | ||||||
| CC: Tweaked can be installed from [CurseForge] or [Modrinth]. It requires the [Minecraft Forge][forge] mod loader, but | CC: Tweaked can be installed from [CurseForge] or [Modrinth]. It runs on both [Minecraft Forge] and [Fabric]. | ||||||
| [versions are available for Fabric][ccrestitched]. |  | ||||||
| 
 | 
 | ||||||
| ## Contributing | ## Contributing | ||||||
| Any contribution is welcome, be that using the mod, reporting bugs or contributing code. If you want to get started | Any contribution is welcome, be that using the mod, reporting bugs or contributing code. If you want to get started | ||||||
| @@ -65,8 +67,8 @@ the generated documentation [can be browsed online](https://tweaked.cc/javadoc/) | |||||||
| [computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub" | [computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub" | ||||||
| [curseforge]: https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked from CurseForge" | [curseforge]: https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked from CurseForge" | ||||||
| [modrinth]: https://modrinth.com/mod/gu7yAYhd "Download CC: Tweaked from Modrinth" | [modrinth]: https://modrinth.com/mod/gu7yAYhd "Download CC: Tweaked from Modrinth" | ||||||
| [forge]: https://files.minecraftforge.net/ "Download Minecraft Forge." | [Minecraft Forge]: https://files.minecraftforge.net/ "Download Minecraft Forge." | ||||||
| [ccrestitched]: https://www.curseforge.com/minecraft/mc-mods/cc-restitched "Download CC: Restitched from CurseForge" | [Fabric]: https://fabricmc.net/use/installer/ "Download Fabric." | ||||||
| [forum]: https://forums.computercraft.cc/ | [forum]: https://forums.computercraft.cc/ | ||||||
| [GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions | [GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions | ||||||
| [IRC]: https://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet" | [IRC]: https://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet" | ||||||
|   | |||||||
| @@ -46,7 +46,7 @@ tasks.publish { dependsOn(publishCurseForge) } | |||||||
| modrinth { | modrinth { | ||||||
|     token.set(findProperty("modrinthApiKey") as String? ?: "") |     token.set(findProperty("modrinthApiKey") as String? ?: "") | ||||||
|     projectId.set("gu7yAYhd") |     projectId.set("gu7yAYhd") | ||||||
|     versionNumber.set("$mcVersion-$modVersion") |     versionNumber.set(modVersion) | ||||||
|     versionName.set(modVersion) |     versionName.set(modVersion) | ||||||
|     versionType.set(if (isUnstable) "alpha" else "release") |     versionType.set(if (isUnstable) "alpha" else "release") | ||||||
|     uploadFile.setProvider(modPublishing.output) |     uploadFile.setProvider(modPublishing.output) | ||||||
|   | |||||||
| @@ -6,10 +6,10 @@ SPDX-License-Identifier: MPL-2.0 | |||||||
| 
 | 
 | ||||||
| #  | #  | ||||||
| CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game. A fork of the | CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game. A fork of the | ||||||
| much-beloved [ComputerCraft], it continues its legacy with better performance, stability, and a wealth of new features. | much-beloved [ComputerCraft], it continues its legacy with improved performance and stability, along with a wealth of | ||||||
|  | new features. | ||||||
| 
 | 
 | ||||||
| CC: Tweaked can be installed from [CurseForge] or [Modrinth]. It requires the [Minecraft Forge][forge] mod loader, but | CC: Tweaked can be installed from [CurseForge] or [Modrinth]. It runs on both [Minecraft Forge] and [Fabric]. | ||||||
| [versions are available for Fabric][ccrestitched]. |  | ||||||
| 
 | 
 | ||||||
| ## Features | ## Features | ||||||
| Controlled using the [Lua programming language][lua], CC: Tweaked's computers provides all the tools you need to start | Controlled using the [Lua programming language][lua], CC: Tweaked's computers provides all the tools you need to start | ||||||
| @@ -54,7 +54,8 @@ CC: Tweaked lives on [GitHub]. If you've got any ideas, feedback or bugs please | |||||||
| [curseforge]: https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked from CurseForge" | [curseforge]: https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked from CurseForge" | ||||||
| [modrinth]: https://modrinth.com/mod/gu7yAYhd "Download CC: Tweaked from Modrinth" | [modrinth]: https://modrinth.com/mod/gu7yAYhd "Download CC: Tweaked from Modrinth" | ||||||
| [forge]: https://files.minecraftforge.net/ "Download Minecraft Forge." | [forge]: https://files.minecraftforge.net/ "Download Minecraft Forge." | ||||||
| [ccrestitched]: https://www.curseforge.com/minecraft/mc-mods/cc-restitched "Download CC: Restitched from CurseForge" | [Minecraft Forge]: https://files.minecraftforge.net/ "Download Minecraft Forge." | ||||||
|  | [Fabric]: https://fabricmc.net/use/installer/ "Download Fabric." | ||||||
| [lua]: https://www.lua.org/ "Lua's main website" | [lua]: https://www.lua.org/ "Lua's main website" | ||||||
| [GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions | [GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions | ||||||
| [IRC]: https://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet" | [IRC]: https://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet" | ||||||
|   | |||||||
| @@ -5,7 +5,7 @@ SPDX-License-Identifier: MPL-2.0 | |||||||
| --> | --> | ||||||
| 
 | 
 | ||||||
| #  | #  | ||||||
| CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game. A fork of the much-beloved [ComputerCraft], it continues its legacy with better performance, stability, and a wealth of new features. | CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game. A fork of the much-beloved [ComputerCraft], it continues its legacy with improved performance and stability, along with a wealth of new features. | ||||||
| 
 | 
 | ||||||
| ## Testimonials | ## Testimonials | ||||||
| 
 | 
 | ||||||
| @@ -58,8 +58,6 @@ CC: Tweaked lives on [GitHub]. If you've got any ideas, feedback or bugs please | |||||||
| [github]: https://github.com/cc-tweaked/CC-Tweaked/ "CC: Tweaked on GitHub" | [github]: https://github.com/cc-tweaked/CC-Tweaked/ "CC: Tweaked on GitHub" | ||||||
| [bug]: https://github.com/cc-tweaked/CC-Tweaked/issues/new/choose | [bug]: https://github.com/cc-tweaked/CC-Tweaked/issues/new/choose | ||||||
| [computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub" | [computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub" | ||||||
| [forge]: https://files.minecraftforge.net/ "Download Minecraft Forge." |  | ||||||
| [ccrestitched]: https://modrinth.com/mod/cc-restitched "Download CC: Restitched from Modrinth" |  | ||||||
| [lua]: https://www.lua.org/ "Lua's main website" | [lua]: https://www.lua.org/ "Lua's main website" | ||||||
| [GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions | [GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions | ||||||
| [IRC]: http://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet" | [IRC]: http://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet" | ||||||
|   | |||||||
| @@ -15,6 +15,7 @@ modId="computercraft" | |||||||
| version="${file.jarVersion}" | version="${file.jarVersion}" | ||||||
| displayName="CC: Tweaked" | displayName="CC: Tweaked" | ||||||
| displayURL="https://tweaked.cc" | displayURL="https://tweaked.cc" | ||||||
|  | updateJSONURL = "https://api.modrinth.com/updates/cc-tweaked/forge_updates.json" | ||||||
|  |  | ||||||
| credits="Created by Daniel Ratcliffe (@DanTwoHundred)" | credits="Created by Daniel Ratcliffe (@DanTwoHundred)" | ||||||
| authors="Daniel Ratcliffe, Aaron Mills, SquidDev" | authors="Daniel Ratcliffe, Aaron Mills, SquidDev" | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user
	 Jonathan Coates
					Jonathan Coates