From 0bb6ec39bd2da5c180e81bc447ef42cab189154a Mon Sep 17 00:00:00 2001 From: Jonathan Coates Date: Tue, 13 Jun 2023 17:37:11 +0100 Subject: [PATCH] Clarify the README a little --- .reuse/dep5 | 1 + README.md | 45 ++++----------------------------------------- doc/logo.png | Bin 0 -> 1563 bytes 3 files changed, 5 insertions(+), 41 deletions(-) create mode 100644 doc/logo.png diff --git a/.reuse/dep5 b/.reuse/dep5 index d47c75e6c..e6b8c6170 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -14,6 +14,7 @@ Copyright: The CC: Tweaked Developers License: MPL-2.0 Files: + doc/logo.png src/main/resources/assets/cctweaked/lua/rom/autorun/.ignoreme src/main/resources/assets/cctweaked/lua/rom/help/* src/main/resources/assets/cctweaked/lua/rom/programs/fun/advanced/levels/* diff --git a/README.md b/README.md index 3771efae7..21bcdf1b7 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ SPDX-License-Identifier: MPL-2.0 # ![CC: Tweaked](doc/logo.png) [![Current build status](https://github.com/cc-tweaked/CC-Tweaked/workflows/Build/badge.svg)](https://github.com/cc-tweaked/CC-Tweaked/actions "Current build status") -[![Download CC: Tweaked on CurseForge](https://img.shields.io/static/v1?label=Download&message=CC:%20Tweaked&color=E04E14&logoColor=E04E14&logo=CurseForge)][CurseForge] [![Download CC: Tweaked on Modrinth](https://img.shields.io/static/v1?label=Download&color=00AF5C&logoColor=00AF5C&logo=Modrinth&message=CC:%20Tweaked)][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. An add-on to the 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 runs on both [Minecraft Forge] and [Fabric]. +CC: Tweaked can be installed from [Modrinth]. It requires [Minecraft Forge] and [ComputerCraft 1.50] and MUST be +installed as a core mod. ## Contributing Any contribution is welcome, be that using the mod, reporting bugs or contributing code. If you want to get started @@ -26,44 +26,6 @@ populated, albeit quiet [IRC channel][irc], if that's more your cup of tea. We also host fairly comprehensive documentation at [tweaked.cc](https://tweaked.cc/ "The CC: Tweaked website"). -## Using -CC: Tweaked is hosted on my maven repo, and so is relatively simple to depend on. You may wish to add a soft (or hard) -dependency in your `mods.toml` file, with the appropriate version bounds, to ensure that API functionality you depend -on is present. - -```groovy -repositories { - maven { - url "https://squiddev.cc/maven/" - content { - includeGroup("cc.tweaked") - includeModule("org.squiddev", "Cobalt") - } - } -} - -dependencies { - // Vanilla (i.e. for multi-loader systems) - compileOnly("cc.tweaked:cc-tweaked-$mcVersion-common-api") - - // Forge Gradle - compileOnly("cc.tweaked:cc-tweaked-$mcVersion-core-api:$cctVersion") - compileOnly(fg.deobf("cc.tweaked:cc-tweaked-$mcVersion-forge-api:$cctVersion")) - runtimeOnly(fg.deobf("cc.tweaked:cc-tweaked-$mcVersion-forge:$cctVersion")) - - // Fabric Loom - modCompileOnly("cc.tweaked:cc-tweaked-$mcVersion-fabric-api:$cctVersion") - modRuntimeOnly("cc.tweaked:cc-tweaked-$mcVersion-fabric:$cctVersion") -} -``` - -You should also be careful to only use classes within the `dan200.computercraft.api` package. Non-API classes are -subject to change at any point. If you depend on functionality outside the API, file an issue, and we can look into -exposing more features. - -We bundle the API sources with the jar, so documentation should be easily viewable within your editor. Alternatively, -the generated documentation [can be browsed online](https://tweaked.cc/javadoc/). - [computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub" [curseforge]: https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked from CurseForge" [modrinth]: https://modrinth.com/mod/gu7yAYhd "Download CC: Tweaked from Modrinth" @@ -72,3 +34,4 @@ the generated documentation [can be browsed online](https://tweaked.cc/javadoc/) [forum]: https://forums.computercraft.cc/ [GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions [IRC]: https://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet" +[ComputerCraft 1.50]: https://modrinth.com/mod/computercraft/version/1.50 "Download ComputerCraft 1.50 from Modrinth" diff --git a/doc/logo.png b/doc/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..33b71f8b69c2382c2f76813fe59e9d7c0f93fe5d GIT binary patch literal 1563 zcmeAS@N?(olHy`uVBq!ia0y~yV4MqNJ8&=q$#2)9t}-w%GX(gAxB|I?f`ZD*$|@=< z>gwv6nwq-0y88P11_lO3Mn=ZQ#-^sGW@cs<78X`kR@T$|opF3N1;bh%~(>2Y_&1=@IS-*b$#*G`dZrytRc=NfVE$5H5pFi1n z{#4`nGmYoYH=aM+df{}#h4T&n|NjTNVHAvpz<`9nYnhviftiD$B*-rqm=s4cUi_I%`=5#su zzAen>d4y~mUx@$P)q5}WS%ntbM_&(hU$y?&l=Xa8F9fXKUa1UT|H`#?#rdFbKVolw zQvb3*?yA#VzohKn=hnRVacX@xP}zdZPIF_wuH7~#R(p4o1G{X=1xI$-{yyL7`%m5b z=(P0J9nHzUcC$;bL!_2(%rtpb(ULc{)~O4mxtY&OPWJMTpvy+C8S~EVT@||gRoVL~ zvv<{B{TkZO3^FXexx^+o!em%aOc|D{>#t(aeLr9npe zS(mn*`mLEE;skO3T(uInEGPBvTVC3pzO(-RkwTC=Uu+3U->@Js% z8_o*$`-_~GzPmdw@_&7n!gcxeqx(IY@h=uQzu2FVdQ&MBb@ E0MwB|p8x;= literal 0 HcmV?d00001