Election-Tech-Initiative · SteveMaier-IRT · Jul 5, 2022
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,27 @@
+## Contributing
+
+This project welcomes contributions and suggestions. Before you get started, you should read the [readme](README.md) and [ElectionGuard Repository](https://github.com/microsoft/electionguard).
+
+- 🤔 **CONSIDER** adding a unit test if your PR resolves an issue.
+- ✅ **DO** check open PR's to avoid duplicates.
+- ✅ **DO** keep pull requests small so they can be easily reviewed.
+- ✅ **DO** build locally before pushing.
+- ✅ **DO** make sure tests pass.
+- ✅ **DO** make sure any new changes are documented.
+- ✅ **DO** make sure not to introduce any compiler warnings.
+- ❌**AVOID** breaking the continuous integration build.
+- ❌**AVOID** making significant changes to the overall architecture.
+
+### Creating a Pull Request
+
+All pull requests should have an accompanying issue. Create one if there is not one matching your code. The code will be checked by continuous integration. Once this CI passes, the code will be reviewed, ideally approved, then merged.
+
+### CLA
+
+Open source contributions require you to agree to a standard Microsoft Contributor License Agreement (CLA) declaring that you grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
+
+### Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
diff --git a/README.md b/README.md
@@ -1,3 +1,30 @@
+![Microsoft Defending Democracy Program: ElectionGuard Tools][banner image]
+
+# 🗳 ElectionGuard Tools
+
+[![ElectionGuard Specification 0.95.0](https://img.shields.io/badge/🗳%20ElectionGuard%20Specification-0.95.0-green)](https://www.electionguard.vote) ![Github Package Action](https://github.com/microsoft/electionguard-python/workflows/Release%20Build/badge.svg) [![](https://img.shields.io/pypi/v/electionguard)](https://pypi.org/project/electionguard/) [![](https://img.shields.io/pypi/dm/electionguard)](https://pypi.org/project/electionguard/) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/microsoft/electionguard-python.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/microsoft/electionguard-python/context:python) [![Total alerts](https://img.shields.io/lgtm/alerts/g/microsoft/electionguard-python.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/microsoft/electionguard-python/alerts/) [![Documentation Status](https://readthedocs.org/projects/electionguard-python/badge/?version=latest)](https://electionguard-python.readthedocs.io) [![license](https://img.shields.io/github/license/microsoft/electionguard)](https://github.com/microsoft/electionguard-python/blob/main/LICENSE)
+
+This repository is a "reference implementation" of ElectionGuard written in Python 3. This implementation can be used to conduct End-to-End Verifiable Elections as well as privacy-enhanced risk-limiting audits. Components of this library can also be used to construct "Verifiers" to validate the results of an ElectionGuard election.
+
+## 📁 In This Repository
+
+| File/folder                                             | Description                                    |
+| ------------------------------------------------------- | ---------------------------------------------- |
+| [docs](/docs)                                           | Documentation for using the tools.             |
+| [src/GenerateVerifierTests](/src/GenerateVerifierTests) | Verifier Test Generator.                       |
+| [CONTRIBUTING.md](/CONTRIBUTING.md)                     | Guidelines for contributing.                   |
+| [README.md](/README.md)                                 | This README file.                              |
+| [LICENSE](/LICENSE)                                     | The license for ElectionGuard-Tools.          |
+
+## ❓ What Is ElectionGuard?
+
+ElectionGuard is an open source software development kit (SDK) that makes voting more secure, transparent and accessible. The ElectionGuard SDK leverages homomorphic encryption to ensure that votes recorded by electronic systems of any type remain encrypted, secure, and secret. Meanwhile, ElectionGuard also allows verifiable and accurate tallying of ballots by any 3rd party organization without compromising secrecy or security.
+
+Learn More in the [ElectionGuard Repository](https://github.com/microsoft/electionguard)
+
+## 🦸 How Can I use ElectionGuard?
+
+ElectionGuard supports a variety of use cases. The Primary use case is to generate verifiable end-to-end (E2E) encrypted elections. The ElectionGuard process can also be used for other use cases such as privacy enhanced risk-limiting audits (RLAs).
 # Project
 
 > This repo has been populated by an initial template to help get you started. Please
@@ -12,22 +39,41 @@ As the maintainer of this project, please make a few updates:
 
 ## Contributing
 
-This project welcomes contributions and suggestions.  Most contributions require you to agree to a
-Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+This project encourages community contributions for development, testing, documentation, code review, and performance analysis, etc. For more information on how to contribute, see [the contribution guidelines][contributing]
+
+### Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+
+### Reporting Issues
+
+Please report any bugs, feature requests, or enhancements using the [GitHub Issue Tracker](https://github.com/microsoft/electionguard-python/issues). Please do not report any security vulnerabilities using the Issue Tracker. Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). See the [Security Documentation][security] for more information.
+
+### Have Questions?
+
+Electionguard would love for you to ask questions out in the open using GitHub Issues. If you really want to email the ElectionGuard team, reach out at [email protected].
+## License
+
+This repository is licensed under the [MIT License]
 
-When you submit a pull request, a CLA bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
-provided by the bot. You will only need to do this once across all repos using our CLA.
+## Thanks! 🎉
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+A huge thank you to those who helped to contribute to this project so far, including:
 
-## Trademarks
+<!-- Links -->
 
-This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
-trademarks or logos is subject to and must follow 
-[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
-Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
-Any use of third-party trademarks or logos are subject to those third-party's policies.
+[banner image]: https://raw.githubusercontent.com/microsoft/electionguard-python/main/images/electionguard-banner.svg
+[pull request workflow]: https://github.com/microsoft/electionguard-python/blob/main/.github/workflows/pull_request.yml
+[contributing]: https://github.com/microsoft/electionguard-python/blob/main/CONTRIBUTING.md
+[security]: https://github.com/microsoft/electionguard-python/blob/main/SECURITY.md
+[design and architecture]: https://github.com/microsoft/electionguard-python/blob/main/docs/Design_and_Architecture.md
+[build and run]: https://github.com/microsoft/electionguard-python/blob/main/docs/Build_and_Run.md
+[project workflow]: https://github.com/microsoft/electionguard-python/blob/main/docs/Project_Workflow.md
+[election manifest]: https://github.com/microsoft/electionguard-python/blob/main/docs/Election_Manifest.md
+[configure election]: https://github.com/microsoft/electionguard-python/blob/main/docs/0_Configure_Election.md
+[key ceremony]: https://github.com/microsoft/electionguard-python/blob/main/docs/1_Key_Ceremony.md
+[encrypt ballots]: https://github.com/microsoft/electionguard-python/blob/main/docs/2_Encrypt_Ballots.md
+[cast and spoil]: https://github.com/microsoft/electionguard-python/blob/main/docs/3_Cast_and_Spoil.md
+[decrypt tally]: https://github.com/microsoft/electionguard-python/blob/main/docs/4_Decrypt_Tally.md
+[publish and verify]: https://github.com/microsoft/electionguard-python/blob/main/docs/5_Publish_and_Verify.md
+[mit license]: https://github.com/microsoft/electionguard-python/blob/main/LICENSE
diff --git a/src/GenerateVerifierTests/GenerateVerifierTests.sln b/src/GenerateVerifierTests/GenerateVerifierTests.sln
@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.2.32602.215
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GenerateVerifierTests", "GenerateVerifierTests\GenerateVerifierTests.csproj", "{C4CA5089-8F2F-44B6-9486-9EBA26B2E912}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{C4CA5089-8F2F-44B6-9486-9EBA26B2E912}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C4CA5089-8F2F-44B6-9486-9EBA26B2E912}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C4CA5089-8F2F-44B6-9486-9EBA26B2E912}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C4CA5089-8F2F-44B6-9486-9EBA26B2E912}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {F94E78AC-B4AD-4FD6-8AE4-E6C03FD8ECB6}
+	EndGlobalSection
+EndGlobal
diff --git a/src/GenerateVerifierTests/GenerateVerifierTests/GenerateVerifierTests.csproj b/src/GenerateVerifierTests/GenerateVerifierTests/GenerateVerifierTests.csproj
@@ -0,0 +1,10 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+</Project>