Ampere Logo

Introduction

Ampere is a robust .NET utility library written in C#. It's main purpose is to make development more productive and easier. The Ampere docs can be found at Ampere Docs.

Execution

Add the dependency to your project with NuGet

You can install the latest release with NuGet by clicking Managing NuGet Packages... under your Visual Studio project name. Browse for the project by typing Ampere, view the information, and choose the version you would like to install.

Install from GitHub Packages

The latest NuGet release can be found under the GitHub Releases Page. You can use the instructions to install from the command line.

Contributing

We are actively looking for contributors to work on all aspects of the code base ― from documentation to building a variety of utilities. For more information on how to contribute, view our CONTRIBUTING.md.

Building Ampere

Prerequisites:

  • Visual Studio 2022 or Later OR VSCode
  • .NET 8 or .NET 10 SDK

The project multi-targets net8.0 and net10.0. The project can be built using dotnet build and the output will display the AssemblyPath.

Documentation

There are two components to Ampere documentation:

  1. Assembly Documentation
  2. Miscellaneous Documentation (README.md, Wiki's, Discussions, etc...)

All Ampere methods are documented using .NET XML documentation. This is compiled using DocFX with the docfx.json file under the DocFX folder. DocFX creates static HTML pages which are used by Ampere Docs. Lastly, as a fluid repository, many files change and constantly need to be documented and updated.

Roadmap

See CHANGELOG.md for a detailed history of changes.

Upcoming:

  • 1.0.0 - Stable release with complete API documentation and full test coverage

State

Ampere is a very fluid project and you may encounter issues during execution, especially for preleases. To report an issue visit, Ampere Issues, or to contribute, view the contribution guidelines.

Licensing

Ampere is licensed under the GNU General Public License v3.0. The GNU General Public License is a free, copyleft license for software and other kinds of works.

Acknowledgements

Thanks especially to my fellow friends and contributors

Edit this page