Skip to content

Commit

Permalink
doc: fix broken links (#5172)
Browse files Browse the repository at this point in the history
* move CODE_OF_CONDUCT.md into .github dir
* move Modules.md and Playing.md into docs dir
* fix broken links in README.md
* link knowledge base directly
* use https instead of http
  • Loading branch information
jdrueckert authored Nov 18, 2023
1 parent 8b4b6b9 commit 432bcb5
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 23 deletions.
File renamed without changes.
39 changes: 16 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
<a href="https://github.com/MovingBlocks/Terasology/releases/latest">
<img src="https://img.shields.io/github/release/MovingBlocks/Terasology.svg" alt="Release" />
</a>
<a href="http://www.apache.org/licenses/LICENSE-2.0">
<a href="https://www.apache.org/licenses/LICENSE-2.0">
<img src="https://img.shields.io/badge/license(code)-Apache%202.0-blue.svg" alt="License (Code)" />
</a>
<a href="http://creativecommons.org/licenses/by/4.0/">
<a href="https://creativecommons.org/licenses/by/4.0/">
<img src="https://img.shields.io/badge/license(art)-CC%20BY%204.0-blue.svg" alt="License (Art)" />
</a>
<a href="https://codeclimate.com/" target="_blank" alt="Code climate">
Expand All @@ -22,15 +22,15 @@

<h3 align="center"><b>
<a href="#community">Community</a> |
<a href="#knowledge-base">Knowledge Base</a> |
<a href="#installation">Installation</a> |
<a href="#development">Development</a> |
<a href="#license">License</a>
<a href="#license">License</a> |
<a href="https://terasology.org/Terasology/#/">Knowledge Base</a>
</b></h3>

The _Terasology_ project was born from a Minecraft-inspired tech demo and is becoming a stable platform for various types of gameplay settings in a voxel world.
The [creators and maintainers](https://github.com/MovingBlocks/Terasology/blob/develop/docs/Credits.md) are a diverse mix of software developers, designers, game testers, graphic artists, and musicians. We encourage others to join!
We encourage contributions from anybody and try to keep a warm and friendly community and maintain a [code of conduct](docs/CODE_OF_CONDUCT.md).
The [creators and maintainers](https://github.com/MovingBlocks/Terasology/graphs/contributors) are a diverse mix of software developers, designers, game testers, graphic artists, and musicians. We encourage others to join!
We encourage contributions from anybody and try to keep a warm and friendly community and maintain a [code of conduct](.github/CODE_OF_CONDUCT.md).

## Community

Expand All @@ -52,7 +52,7 @@ We are present in nearly the complete round-up of social networks. Follow/friend
<img src="./docs/images/facebook.png" width="48px"/>
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a title="Reddit" href="http://www.reddit.com/r/Terasology">
<a title="Reddit" href="https://www.reddit.com/r/Terasology">
<img src="./docs/images/reddit.png" width="48px"/>
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
Expand All @@ -69,12 +69,6 @@ We are present in nearly the complete round-up of social networks. Follow/friend
</a>
</p>


## Knowledge Base

Find documentation, instructions, and helpful references in our [Terasology Knowledge Base](http://terasology.org/Terasology/#/), formerly known as the Terasology Engine wiki.


## Installation

<table>
Expand Down Expand Up @@ -113,7 +107,7 @@ Find documentation, instructions, and helpful references in our [Terasology Know

Internet connectivity is required for downloading Terasology via the Launcher, afterwards playing offline is possible.

For easy game setup (recommended) you can use our launcher - [download it here](https://terasology.org/download.html).
For easy game setup (recommended) you can use our launcher - [download it here](https://terasology.org/downloads/).

For more information about playing, like hot keys or server hosting, see the [dedicated page](docs/Playing.md) or check out the [modules](docs/Modules.md).

Expand All @@ -122,7 +116,7 @@ For more information about playing, like hot keys or server hosting, see the [de

If you already have a Java Development Kit (JDK) installed, you may use a direct download release as an alternative to using the [launcher](https://github.com/MovingBlocks/TerasologyLauncher/releases). Java version 17 is required.

Direct download stable builds are uploaded to [our release section here on GitHub](https://github.com/MovingBlocks/Terasology/releases) while the cutting-edge develop version can be downloaded direct [here from our Jenkins](https://jenkins.terasology.io/teraorg/job/Terasology/job/Omega/job/master/lastSuccessfulBuild/artifact/distros/omega/build/distributions/TerasologyOmega.zip).
ßDirect download stable builds are uploaded to [our release section here on GitHub](https://github.com/MovingBlocks/Terasology/releases) while the cutting-edge develop version can be downloaded direct [here from our Jenkins](https://jenkins.terasology.io/job/Terasology/job/Omega/job/develop/lastSuccessfulBuild/artifact/distros/omega/build/distributions/TerasologyOmega.zip).


## Development
Expand All @@ -143,8 +137,8 @@ Non-Technical Requirements:
### Workspace Setup

To be able to run **Terasology** from source, you'll need to setup your workspace.
Follow the [Contributor Quick Start Guide](https://github.com/MovingBlocks/Terasology/wiki/Contributor-Quick-Start).
This guide is designed for [IntelliJ IDEA](http://www.jetbrains.com/idea/) (you can use the free community edition), but alternative setups are possible.
Follow the [Contributor Quick Start Guide](https://terasology.org/Terasology/#/Contributor-Quick-Start).
This guide is designed for [IntelliJ IDEA](https://www.jetbrains.com/idea/) (you can use the free community edition), but alternative setups are possible.

> :warning: _Note, that a Terasology workspace is a **multi-repo workspace**._
Expand All @@ -153,17 +147,16 @@ While your workspace itself is a clone of [MovingBlocks/Terasology](https://gith
Accordingly, if you want to contribute to modules, you'll need to navigate into the respective subdirectory and work with Git from in there.
Any Git commands executed in your workspace root will target [MovingBlocks/Terasology](https://github.com/MovingBlocks/Terasology).

For more information, see our wiki entry on [Understanding Terasology's Git Setup](https://github.com/MovingBlocks/Terasology/wiki/Developing-Modules#understanding-terasologys-git-setup).
For more information, see our wiki entry on [Understanding Terasology's Git Setup](https://terasology.org/Terasology/#/Developing-Modules?id=understanding-terasology39s-git-setup).


### Contributing

Detailed information on how to contribute can be found in [CONTRIBUTING.md](./.github/CONTRIBUTING.md). Remember, that all submissions must be licensed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
Detailed information on how to contribute can be found in [CONTRIBUTING.md](.github/CONTRIBUTING.md). Remember, that all submissions must be licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

Terasology has a rather steep learning curve in the beginning.
To help you with the learning process, our [Adventure Site](https://terasology.org/AdventureSite/#/) helps you find the resources you need according to the field of contribution you're interested in.

Additional learning resources can be found in our [wiki](https://github.com/MovingBlocks/Terasology/wiki) and our [tutorial modules](https://github.com/Terasology?q=Tutorial&type=all&language=&sort=).
To help you with the learning process, our [Terasology Knowledge Base](https://terasology.org/Terasology/#/), formerly known as the Terasology Engine wiki, helps you find the resources you need according to the field of contribution you're interested in.
Additional learning resources can be found in our [tutorial modules](https://github.com/Terasology?q=Tutorial&type=all&language=&sort=).

If you find errors or issues in any of our resources, please report them using GitHub issues and help fix them.

Expand All @@ -173,4 +166,4 @@ Developers with previous experience in rendering, physics and other less trivial

## License

Terasology is fully open source and licensed [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) for code and [Creative Commons Attribution License, Version 4.0](http://creativecommons.org/licenses/by/4.0/) for artwork (unless indicated otherwise - see credits for minor exceptions).
Terasology is fully open source and licensed [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) for code and [Creative Commons Attribution License, Version 4.0](https://creativecommons.org/licenses/by/4.0/) for artwork (unless indicated otherwise - see credits for minor exceptions).
File renamed without changes.
File renamed without changes.

0 comments on commit 432bcb5

Please sign in to comment.