diff --git a/Docs/index.md b/Docs/index.md index c809310..93f1da1 100644 --- a/Docs/index.md +++ b/Docs/index.md @@ -1,4 +1,4 @@ -The MLEM logo +![The MLEM logo](https://raw.githubusercontent.com/Ellpeck/MLEM/release/Media/Banner.png) **MLEM Library for Extending MonoGame** is an addition to the game framework [MonoGame](https://www.monogame.net/) that provides extension methods, quality of life improvements and additional features like a ui system and easy input handling. @@ -6,9 +6,9 @@ - Get it on [NuGet](https://www.nuget.org/packages?q=mlem) - Get prerelease builds on [BaGet](https://nuget.ellpeck.de) - See the source code on [GitHub](https://github.com/Ellpeck/MLEM) -- See tutorials and API documentation on this website -- Check out [the demos](https://github.com/Ellpeck/MLEM/tree/main/Demos) on [Desktop](https://github.com/Ellpeck/MLEM/tree/main/Demos.DesktopGL) or [Android](https://github.com/Ellpeck/MLEM/tree/main/Demos.Android) -- See [the changelog](../CHANGELOG.md) for information on updates +- See tutorials and API documentation on [the website](https://mlem.ellpeck.de/) +- Check out [the demos](https://github.com/Ellpeck/MLEM/tree/release/Demos) on [Desktop](https://github.com/Ellpeck/MLEM/tree/release/Demos.DesktopGL) or [Android](https://github.com/Ellpeck/MLEM/tree/release/Demos.Android) +- See [the changelog](https://mlem.ellpeck.de/CHANGELOG.html) for information on updates # Made with MLEM - [A Breath of Spring Air](https://ellpeck.itch.io/a-breath-of-spring-air), a short platformer ([Source](https://git.ellpeck.de/Ellpeck/GreatSpringGameJam)) @@ -22,11 +22,11 @@ Here are some images that show a couple of MLEM's features. The [MLEM.Ui](https://mlem.ellpeck.de/articles/ui) demo in action: -A gif showing various user interface elements from the MLEM.Ui demo +![A gif showing various user interface elements from the MLEM.Ui demo](https://raw.githubusercontent.com/Ellpeck/MLEM/release/Media/Ui.gif) MLEM's [text formatting system](https://mlem.ellpeck.de/articles/text_formatting), which is compatible with both MLEM.Ui and regular sprite batch rendering: -An image showing text with various colors and other formatting +![An image showing text with various colors and other formatting](https://raw.githubusercontent.com/Ellpeck/MLEM/release/Media/Formatting.png) # Friends of MLEM There are several other NuGet packages and tools that work well in combination with MonoGame and MLEM. Here are some of them: diff --git a/MLEM.Data/MLEM.Data.csproj b/MLEM.Data/MLEM.Data.csproj index e3b1ba9..0aa3ac2 100644 --- a/MLEM.Data/MLEM.Data.csproj +++ b/MLEM.Data/MLEM.Data.csproj @@ -13,6 +13,7 @@ https://github.com/Ellpeck/MLEM MIT Logo.png + README.md @@ -32,5 +33,6 @@ + \ No newline at end of file diff --git a/MLEM.Extended/MLEM.Extended.csproj b/MLEM.Extended/MLEM.Extended.csproj index 8039c4a..4bd88db 100644 --- a/MLEM.Extended/MLEM.Extended.csproj +++ b/MLEM.Extended/MLEM.Extended.csproj @@ -13,6 +13,7 @@ https://github.com/Ellpeck/MLEM MIT Logo.png + README.md @@ -34,5 +35,6 @@ + \ No newline at end of file diff --git a/MLEM.Startup/MLEM.Startup.csproj b/MLEM.Startup/MLEM.Startup.csproj index 8261582..b0e32c8 100644 --- a/MLEM.Startup/MLEM.Startup.csproj +++ b/MLEM.Startup/MLEM.Startup.csproj @@ -14,6 +14,7 @@ https://github.com/Ellpeck/MLEM MIT Logo.png + README.md @@ -28,5 +29,6 @@ + diff --git a/MLEM.Templates/MLEM.Templates.csproj b/MLEM.Templates/MLEM.Templates.csproj index ec05447..ef13122 100644 --- a/MLEM.Templates/MLEM.Templates.csproj +++ b/MLEM.Templates/MLEM.Templates.csproj @@ -19,12 +19,14 @@ https://mlem.ellpeck.de/ https://github.com/Ellpeck/MLEM Logo.png + README.md + \ No newline at end of file diff --git a/MLEM.Ui/MLEM.Ui.csproj b/MLEM.Ui/MLEM.Ui.csproj index aecac48..3c4128a 100644 --- a/MLEM.Ui/MLEM.Ui.csproj +++ b/MLEM.Ui/MLEM.Ui.csproj @@ -13,6 +13,7 @@ https://github.com/Ellpeck/MLEM MIT Logo.png + README.md @@ -26,5 +27,6 @@ + \ No newline at end of file diff --git a/MLEM/MLEM.csproj b/MLEM/MLEM.csproj index 58596c8..ef9bd08 100644 --- a/MLEM/MLEM.csproj +++ b/MLEM/MLEM.csproj @@ -13,6 +13,7 @@ https://github.com/Ellpeck/MLEM MIT Logo.png + README.md @@ -23,5 +24,6 @@ + \ No newline at end of file diff --git a/Media/Banner.png b/Media/Banner.png new file mode 100644 index 0000000..dd50e11 Binary files /dev/null and b/Media/Banner.png differ diff --git a/README.md b/README.md index 5a9b722..014a865 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -The MLEM logo +![The MLEM logo](https://raw.githubusercontent.com/Ellpeck/MLEM/main/Media/Banner.png) **MLEM Library for Extending MonoGame** is an addition to the game framework [MonoGame](https://www.monogame.net/) that provides extension methods, quality of life improvements and additional features like a ui system and easy input handling. # What next? - Get it on [NuGet](https://www.nuget.org/packages?q=mlem) - Get prerelease builds on [BaGet](https://nuget.ellpeck.de) -- See the source code in this repository +- See the source code on [GitHub](https://github.com/Ellpeck/MLEM) - See tutorials and API documentation on [the website](https://mlem.ellpeck.de/) - Check out [the demos](https://github.com/Ellpeck/MLEM/tree/main/Demos) on [Desktop](https://github.com/Ellpeck/MLEM/tree/main/Demos.DesktopGL) or [Android](https://github.com/Ellpeck/MLEM/tree/main/Demos.Android) - See [the changelog](https://github.com/Ellpeck/MLEM/blob/main/CHANGELOG.md) for information on updates @@ -22,11 +22,11 @@ Here are some images that show a couple of MLEM's features. The [MLEM.Ui](https://mlem.ellpeck.de/articles/ui) demo in action: -A gif showing various user interface elements from the MLEM.Ui demo +![A gif showing various user interface elements from the MLEM.Ui demo](https://raw.githubusercontent.com/Ellpeck/MLEM/main/Media/Ui.gif) MLEM's [text formatting system](https://mlem.ellpeck.de/articles/text_formatting), which is compatible with both MLEM.Ui and regular sprite batch rendering: -An image showing text with various colors and other formatting +![An image showing text with various colors and other formatting](https://raw.githubusercontent.com/Ellpeck/MLEM/main/Media/Formatting.png) # Friends of MLEM There are several other NuGet packages and tools that work well in combination with MonoGame and MLEM. Here are some of them: