Add Mathematics.NET logo

README.md

@@ -1,12 +1,16 @@
-# Mathematics.NET
-
-Mathematics.NET is a C# class library that provides tools for solving mathematical problems.
+<div style="text-align: center">
+    <img src="https://github.com/HamletTanyavong/Mathematics.NET/tree/main/docs/images/logo/mathematics.net.png" alt="Mathematics.NET Logo">
+    <h1>Mathematics.NET</h1>
+    <p>Mathematics.NET is a C# class library that provides tools for solving mathematical problems.</p>
+</div>
 
 [![GitHub](https://img.shields.io/github/license/HamletTanyavong/Mathematics.NET?style=flat-square&logo=github&labelColor=87cefa&color=ffd700)](https://github.com/HamletTanyavong/Mathematics.NET)
 [![GitHub Repo Stars](https://img.shields.io/github/stars/HamletTanyavong/Mathematics.NET?color=87cefa&style=flat-square&logo=github)](https://github.com/HamletTanyavong/Mathematics.NET/stargazers)
 [![NuGet](https://img.shields.io/nuget/v/Physics.NET.Mathematics?style=flat-square&logo=nuget)](https://www.nuget.org/packages/Physics.NET.Mathematics)
 [![NuGet](https://img.shields.io/nuget/dt/Physics.NET.Mathematics?style=flat-square&logo=nuget)](https://www.nuget.org/packages/Physics.NET.Mathematics)
 
-## Documentation
+## About
+
+Mathematics.NET provides custom types for complex, real, and rational numbers as well as other mathematical objects such as vectors, matrices, and tensors.[^1]
 
-Please visit the [documentation site](https://mathematics.hamlettanyavong.com) for detailed information.
+[^1]: Please visit the [documentation site](https://mathematics.hamlettanyavong.com) for detailed information.

docs/docfx.json

@@ -48,6 +48,8 @@
     "globalMetadata" :{
       "_appTitle": "Mathematics.NET",
       "_appFooter": "Copyright © 2023 Hamlet Tanyavong",
+      "_appLogoPath": "images/logo/mathematics.net.png",
+      "_appFaviconPath": "images/logo/mathematics.net.ico",
       "_disableContribution": true,
       "_enableSearch": true
     }

docs/index.md

@@ -1,8 +1,18 @@
-# Mathematics.NET
-
-Mathematics.NET is a C# class library that provides tools for solving mathematical problems.
+<div id="interactive-card">
+    <div id="overlay"></div>
+    <div class="flare" id="circle-one"></div>
+    <div class="flare" id="circle-two"></div>
+    <div class="flare" id="circle-three"></div>
+    <img src="/images/logo/mathematics.png" alt="Mathematics.NET Logo">
+    <h1>Mathematics.NET</h1>
+    <p>Mathematics.NET is a C# class library that provides tools for solving mathematical problems.</p>
+</div>
 
 [![GitHub](https://img.shields.io/github/license/HamletTanyavong/Mathematics.NET?style=flat-square&logo=github&labelColor=87cefa&color=ffd700)](https://github.com/HamletTanyavong/Mathematics.NET)
 [![GitHub Repo Stars](https://img.shields.io/github/stars/HamletTanyavong/Mathematics.NET?color=87cefa&style=flat-square&logo=github)](https://github.com/HamletTanyavong/Mathematics.NET/stargazers)
 [![NuGet](https://img.shields.io/nuget/v/Physics.NET.Mathematics?style=flat-square&logo=nuget)](https://www.nuget.org/packages/Physics.NET.Mathematics)
 [![NuGet](https://img.shields.io/nuget/dt/Physics.NET.Mathematics?style=flat-square&logo=nuget)](https://www.nuget.org/packages/Physics.NET.Mathematics)
+
+## About
+
+Mathematics.NET provides custom types for complex, real, and rational numbers as well as other mathematical objects such as vectors, matrices, and tensors.

docs/template/public/main.css

@@ -8,20 +8,74 @@
   --bg-color-secondary: #b4f8f8;
 }
 
-header {
-  --bs-border-width: 0px;
+#logo {
+  width: 50px;
+  height: 50px;
+}
+
+/* Interactive Card */
+
+#interactive-card {
+  position: relative;
+  text-align: center;
+}
+
+  #interactive-card > .flare,
+  #overlay {
+    position: absolute;
+    transition: ease-out;
+    transition-duration: 250ms;
+    opacity: 0;
+    pointer-events: none;
+  }
+
+  #interactive-card:hover > #overlay,
+  #interactive-card:hover > .flare {
+    opacity: 1;
+  }
+
+#overlay {
+  width: 100%;
+  height: 100%;
+}
+
+#circle-one {
+  background-color: #ffffff80;
+  width: 32px;
+  height: 32px;
+  border-radius: 16px;
+}
+
+#circle-two {
+  background-color: #ffd70040;
+  width: 64px;
+  height: 64px;
+  border-radius: 32px;
 }
 
+#circle-three {
+  background-color: #86cefa20;
+  width: 128px;
+  height: 128px;
+  border-radius: 64px;
+}
+
+/* Common */
+
 body {
   background-color: var(--bg-color-primary);
 }
 
-  body > footer {
-    display: flex;
-    align-items: center;
-    padding: 0rem;
-    height: 3rem;
-  }
+body > footer {
+  display: flex;
+  align-items: center;
+  padding: 0rem;
+  height: 3rem;
+}
+
+header {
+  --bs-border-width: 0px;
+}
 
 footer {
   background-color: var(--bg-color-secondary);
@@ -40,6 +94,22 @@ a {
     text-decoration: underline;
   }
 
+.tabGroup > section {
+  border: 0px;
+  border-radius: 0.5rem;
+}
+
+.nav-tabs {
+  margin-bottom: 0.5rem;
+  border-bottom: 0px;
+  --bs-nav-tabs-border-width: 0px;
+  --bs-nav-tabs-border-radius: 0px;
+}
+
+.nav-item:hover {
+  background-color: var(--bg-color-secondary);
+}
+
 .bg-body {
   background-color: var(--bg-color-secondary);
 }

docs/template/public/main.js

@@ -13,3 +13,40 @@ export default {
     }
   ]
 }
+
+document.addEventListener("DOMContentLoaded", function () {
+  const interactiveCard = document.getElementById("interactive-card");
+
+  const overlay = document.getElementById("overlay");
+
+  const circleOne = document.getElementById("circle-one");
+  const circleOneRadius = circleOne.offsetWidth / 2;
+
+  const circleTwo = document.getElementById("circle-two");
+  const circleTwoRadius = circleTwo.offsetWidth / 2;
+
+  const circleThree = document.getElementById("circle-three");
+  const circleThreeRadius = circleThree.offsetWidth / 2;
+
+  interactiveCard.addEventListener("mousemove", function (event) {
+    var boundingRectangle = interactiveCard.getBoundingClientRect();
+    var centerX = interactiveCard.clientWidth / 2;
+    var centerY = interactiveCard.clientHeight / 2;
+    var x = event.clientX - boundingRectangle.left - centerX;
+    var y = event.clientY - boundingRectangle.top - centerY;
+
+    var magnitude = Math.hypot(x, y);
+    var maxMagnitude = Math.hypot(centerX, centerY);
+
+    overlay.style.backgroundColor = `rgba(255, 255, 255, ${0.1 * Math.cos(magnitude / maxMagnitude * Math.PI / 2)})`;
+
+    circleOne.style.left = `${x / 2 - circleOneRadius + centerX}px`;
+    circleOne.style.top = `${y / 2 - circleOneRadius + centerY}px`;
+
+    circleTwo.style.left = `${-x - circleTwoRadius + centerX}px`;
+    circleTwo.style.top = `${-y - circleTwoRadius + centerY}px`;
+
+    circleThree.style.left = `${-4 * x - circleThreeRadius + centerX}px`;
+    circleThree.style.top = `${-4 * y - circleThreeRadius + centerY}px`;
+  });
+});

src/Mathematics.NET/DifferentialGeometry/NoIndex.cs

@@ -29,7 +29,7 @@
 
 namespace Mathematics.NET.DifferentialGeometry;
 
-/// <summary>Indicates that no specific index is specified</summary>
+/// <summary>Indicates that no index has been specified</summary>
 public struct NoIndex : IIndex
 {
     public static IIndex Instance => new NoIndex();

src/Mathematics.NET/Mathematics.NET.csproj

@@ -8,6 +8,7 @@
     <Platforms>x64</Platforms>
     <Title>Mathematics.NET</Title>
     <Version>0.1.0-alpha.2</Version>
+    <PackageIcon>mathematics.net.png</PackageIcon>
     <Authors>Hamlet Tanyavong</Authors>
     <Description>Mathematics.NET is a C# class library that provides tools for solving mathematical problems.</Description>
     <PackageTags>mathematics; math; maths</PackageTags>
@@ -25,21 +26,22 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <None Include="..\..\LICENSE">
+    <None Include="..\..\docs\images\logo\mathematics.net.png">
       <Pack>True</Pack>
       <PackagePath>\</PackagePath>
     </None>
-    <None Include="..\..\README.md">
+    <None Include="..\..\LICENSE">
       <Pack>True</Pack>
       <PackagePath>\</PackagePath>
     </None>
+    <None Update="README.md">
+        <Pack>True</Pack>
+        <PackagePath>\</PackagePath>
+    </None>
   </ItemGroup>
 
   <ItemGroup>
     <PackageReference Include="CommunityToolkit.HighPerformance" Version="8.2.1" />
-  </ItemGroup>
-
-  <ItemGroup>
     <ProjectReference Include="..\Mathematics.NET.SourceGenerators\Mathematics.NET.SourceGenerators.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
   </ItemGroup>
 

src/Mathematics.NET/README.md

@@ -0,0 +1,16 @@
+![Mathematics.NET Logo](https://github.com/HamletTanyavong/Mathematics.NET/tree/main/docs/images/logo/mathematics.net.png "Mathematics.NET Logo")
+
+# Mathematics.NET
+
+Mathematics.NET is a C# class library that provides tools for solving mathematical problems
+
+[![GitHub](https://img.shields.io/github/license/HamletTanyavong/Mathematics.NET?style=flat-square&logo=github&labelColor=87cefa&color=ffd700)](https://github.com/HamletTanyavong/Mathematics.NET)
+[![GitHub Repo Stars](https://img.shields.io/github/stars/HamletTanyavong/Mathematics.NET?color=87cefa&style=flat-square&logo=github)](https://github.com/HamletTanyavong/Mathematics.NET/stargazers)
+[![NuGet](https://img.shields.io/nuget/v/Physics.NET.Mathematics?style=flat-square&logo=nuget)](https://www.nuget.org/packages/Physics.NET.Mathematics)
+[![NuGet](https://img.shields.io/nuget/dt/Physics.NET.Mathematics?style=flat-square&logo=nuget)](https://www.nuget.org/packages/Physics.NET.Mathematics)
+
+## About
+
+Mathematics.NET provides custom types for complex, real, and rational numbers as well as other mathematical objects such as vectors, matrices, and tensors.[^1]
+
+[^1]: Please visit the [documentation site](https://mathematics.hamlettanyavong.com) for detailed information.