docs: writing some shell documentation
All checks were successful
deploy / deploy (push) Successful in 40m25s
All checks were successful
deploy / deploy (push) Successful in 40m25s
This commit is contained in:
parent
7aa761c4cd
commit
46f19fd4e8
34
README.md
Normal file
34
README.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
# MfGames CIL (C# and .NET) Libraries
|
||||
|
||||
This [monorepo](https://en.wikipedia.org/wiki/Monorepo) is the collection of all Moonfire Games's libraries for languages supported by the [Common Intermediate Language](https://en.wikipedia.org/wiki/Common_Intermediate_Language) (CIL), also known as .NET and C#. Some of these libraries have roots back into development since 2001 and they have gone through a number of iterations.
|
||||
|
||||
## Documentation
|
||||
|
||||
The documentation for the entire project can be found in the [./docs/ folders](./docs/index.md) of this registry, but below are some notable links there.
|
||||
|
||||
- [MfGames.Gallium](./docs/gallium/index.md) - A toy Entity-Component-System (ECS) modeled after LINQ methods calls and suitable for environment where ease of use is more critical than performance.
|
||||
- [MfGames.Nitride](./docs/nitride/index.md) - A flexible, configuration-as-code, static site generator build on top of MfGames.Gallium.
|
||||
|
||||
## Installing Packages
|
||||
|
||||
These packages are not available on NuGet.org, but are available through the MfGames package register for this project. The best way to use them is to configure the `NuGet.config` file in the root of the project.
|
||||
|
||||
```xml
|
||||
<!-- NuGet.Config --
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<configuration>
|
||||
<packageSources>
|
||||
<clear />
|
||||
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
|
||||
<add key="mfgames.com" value="https://src.mfgames.com/api/packages/mfgames-cil/nuget/index.json" protocolVersion="3" />
|
||||
</packageSources>
|
||||
<packageSourceMapping>
|
||||
<packageSource key="nuget.org">
|
||||
<package pattern="*" />
|
||||
</packageSource>
|
||||
<packageSource key="mfgames.com">
|
||||
<package pattern="MfGames.*" />
|
||||
</packageSource>
|
||||
</packageSourceMapping>
|
||||
</configuration>
|
||||
```
|
Loading…
Reference in a new issue