Ellpeck/TinyLifeWeb
1
0
Fork 0
mirror of https://github.com/Ellpeck/TinyLifeWeb.git synced 2024-05-02 08:07:50 +02:00
Code Issues Projects Releases Wiki Activity

clean up index and readme

Browse source
This commit is contained in:
Ell 2024-03-19 14:40:26 +01:00
parent 6c2271e304
commit 8978e0e34c
3 changed files with 6 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,15 +1,5 @@
![The Tiny Life banner](https://raw.githubusercontent.com/Ellpeck/TinyLifeWeb/main/docs/media/banner.png)
Welcome to the Tiny Life Modding API! On [the site](https://docs.tinylifegame.com), you can find the full modding API documentation, a bunch of modding tutorials, as well as an online version of the game's changelog.
This is the repository for the [Tiny Life website](https://tinylifegame.com), which you can find in the `web` directory, as well as the [Tiny Life Developer Docs](https://docs.tinylifegame.com), which you can find in the `docs` directory.
# What next?
- To install a mod, custom lot or custom household, check out the [custom content installation](https://docs.tinylifegame.com/articles/getting.html) tutorial.
- To create your first mod, check out the [modding basics](https://docs.tinylifegame.com/articles/mod_basics.html) tutorial or the [example mod](https://github.com/Ellpeck/TinyLifeExampleMod).
- This site features a web version of the modding API's [documentation](https://docs.tinylifegame.com/api/TinyLife.html) as well, which is a verbatim copy of the XML documentation that you can find in the API's source.
# Contributing
If you've made a mod for Tiny Life before, and you think you know what you're doing, you can help others by contributing your own tutorial articles or improving existing ones. You can get started doing so by [submitting a pull request](https://github.com/Ellpeck/TinyLifeWeb/pulls).
If you found an error in the game's API or its documentation, you can also [submit an issue](https://github.com/Ellpeck/TinyLifeWeb/issues).
Thank you for supporting Tiny Life's custom content community!
Additional documentation for various parts of the game and its development can be found on [the wiki](https://wiki.tinylifegame.com), as well.

13
docs/index.md
View file

@ -1,15 +1,8 @@
![The Tiny Life banner](media/banner.png)
Welcome to the Tiny Life Modding API! On here, you can find the full modding API documentation, a bunch of modding tutorials, as well as an online version of the game's changelog.
## What next?
- To install a mod, custom lot or custom household, check out the [custom content installation](~/articles/getting.md) tutorial.
- To create your first mod, check out the [modding basics](~/articles/mod_basics.md) tutorial or the [example mod](https://github.com/Ellpeck/TinyLifeExampleMod).
- This site features a web version of the modding API's [documentation](xref:TinyLife) as well, which is a verbatim copy of the XML documentation that you can find in the API's source.
Welcome to the Tiny Life Developer Docs! On here, you can find the full modding API documentation, as well as links to various modding tutorials and additional information that you can also find on [the wiki](https://wiki.tinylifegame.com).
## Contributing
If you've made a mod for Tiny Life before, and you think you know what you're doing, you can help others by contributing your own tutorial articles or improving existing ones. You can get started doing so by [submitting a pull request](https://github.com/Ellpeck/TinyLifeWeb/pulls). If you do, please start out with a draft pull request so we can communicate about your plans for the content you're contributing.
If you found an error in the game's API or its documentation, please feel free to [submit an issue](https://github.com/Ellpeck/TinyLifeWeb/issues).
If you found an error in the game's API or its documentation, you can also [submit an issue](https://github.com/Ellpeck/TinyLifeWeb/issues).
Thank you for supporting Tiny Life's custom content community!
Since the API documentation is generated automatically, the `docs/api` directory on the repository should not be edited through pull requests.

2
docs/toc.yml
View file

@ -2,7 +2,7 @@
href: https://tinylifegame.com
- name: Wiki
href: https://wiki.tinylifegame.com
- name: Home
- name: Docs Home
href: /
- name: Tutorials
href: articles/