mirror of
https://github.com/Ellpeck/TinyLifeWeb.git
synced 2024-11-25 12:38:34 +01:00
added the docs readme to the nuget package
This commit is contained in:
parent
4e34f54db2
commit
4af8ef78a4
3 changed files with 8 additions and 8 deletions
|
@ -1,11 +1,11 @@
|
|||
<img src="media/banner.png" width="50%">
|
||||
![The Tiny Life banner](https://raw.githubusercontent.com/Ellpeck/TinyLifeDocs/main/media/banner.png)
|
||||
|
||||
Welcome to the source code for the Tiny Life documentation site! On the site, you can find the full modding API documentation, a bunch of modding tutorials, as well as an online version of the game's changelog.
|
||||
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.
|
||||
|
||||
# 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) as well, which is a verbatim copy of the XML documentation that you can find in the API's source.
|
||||
- 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/TinyLifeDocs/pulls). If you found an error in the game's API documentation, you can also [submit an issue](https://github.com/Ellpeck/TinyLifeDocs/issues).
|
||||
|
|
10
index.md
10
index.md
|
@ -1,11 +1,11 @@
|
|||
<img src="media/banner.png" width="50%">
|
||||
![The Tiny Life banner](media/banner.png)
|
||||
|
||||
Welcome to the Tiny Life documentation site! 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.
|
||||
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](https://docs.tinylifegame.com/articles/getting.html) tutorial.
|
||||
- To create your first mod, check out the [modding basics](/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) as well, which is a verbatim copy of the XML documentation that you can find in the API's source.
|
||||
- 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.
|
||||
|
||||
# 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/TinyLifeDocs/pulls). If you found an error in the game's API documentation, you can also [submit an issue](https://github.com/Ellpeck/TinyLifeDocs/issues).
|
||||
|
|
BIN
media/banner.png
BIN
media/banner.png
Binary file not shown.
Before Width: | Height: | Size: 9.1 KiB After Width: | Height: | Size: 22 KiB |
Loading…
Reference in a new issue