Skip to content

Commit

Permalink
Update README with project-specific details
Browse files Browse the repository at this point in the history
This commit replaces the generic template instructions in the README with specific information about the NexusMods.Hashing.XxHash64 project. This change includes adding project badges and a brief description of the project.
  • Loading branch information
halgari committed Aug 15, 2023
1 parent 9b3fd35 commit df45aa8
Showing 1 changed file with 5 additions and 30 deletions.
35 changes: 5 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,12 @@
# NexusMods.App.Template
# NexusMods.Hashing.XxHash64
[![Test Coverage](https://codecov.io/gh/Nexus-Mods/NexusMods.Hashing.xxHash64/branch/main/graph/badge.svg?token=RR2Lic1E0M)](https://codecov.io/gh/Nexus-Mods/NexusMods.Hashing.xxHash64)
[![CI Tests](https://github.com/Nexus-Mods/NexusMods.Hashing.xxHash64/actions/workflows/dotnet-build-and-test.yaml/badge.svg)](https://github.com/Nexus-Mods/NexusMods.Hashing.xxHash64/actions/workflows/dotnet-build-and-test.yaml)

This is a template repository for `NexusMods.App.*` repositories.
An implementation of the xxHash64 algorithm for .NET. Extremely fast and lightweight.

## How to use
Extension methods for `Stream` and the Nexus `AbsoultePath` types.

The following is a checklist of things you need to do after creating a new repository with this template.

1) Update the project settings:
1) `Settings` -> uncheck `Wikis` (under Features)
2) `Settings` -> check `Automatically delete head branches`
3) `Settings` -> `Collaborators and teams` -> `Add Teams`
- Add `NexusMods.App Admin` with role `Admin`
- Add `NexusMods.App Developers` with role `Maintain`
- Remove yourself as a collaborator
4) `Settings` -> `Rules` -> `Rulesets` and add a new one:
- Call it `Branch PR Rules`
- Add `Repository admin` to the `Bypass list`
- Add `Include default branch` as a target
- Only check the following branch protections:
- `Restrict deletions`
- `Require signed commits`
- `Require a pull request` before merging with **1** required approvals
- `Require status checks to pass before merging`
- `Block force pushes`
5) `Settings` -> `Pages` and change `Source` to **GitHub Actions**
2) Rename the Solution and existing Projects
3) Update the docs:
1) Open [`mkdocs.yml`](./mkdocs.yml) and update the first four fields:
- `site_name` and `site_url`
- `repo_name` and `repo_url`
2) Update the docs in [`docs`](./docs). At least change the [`index.md`](./docs/index.md) file.

Finally, update this README.

## License

Expand Down

0 comments on commit df45aa8

Please sign in to comment.