Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
erri120 committed Jul 18, 2023
1 parent 6eb03c1 commit ada30fe
Showing 1 changed file with 2 additions and 33 deletions.
35 changes: 2 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,6 @@
# NexusMods.App.Template
# NexusMods.Paths

This is a template repository for `NexusMods.App.*` repositories.

## How to use

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.
Custom path library used by [NexusMods.App](https://github.com/Nexus-Mods/NexusMods.App).

## License

Expand Down

0 comments on commit ada30fe

Please sign in to comment.