Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

Commit

Permalink
Add archival notice to README (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
krossgg authored Jan 13, 2025
1 parent 30d4751 commit 2bff261
Showing 1 changed file with 5 additions and 23 deletions.
28 changes: 5 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,6 @@
# GregTech CEu Modern Documentation

This documentation project is built using [MkDocs](https://www.mkdocs.org/#).

For an automatically updating live preview in your browser, run `mkdocs serve`


## Installing Required Dependencies

To install the required dependencies, please run `pip install -r requirements.txt`


## Used MkDocs Plugins

The following plugins for MkDocs are being used:

- https://squidfunk.github.io/mkdocs-material/
- https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin

## Contributing

When contributing to this project, please refer to the [Styleguide](./CONTRIBUTING.md).
I know it's kinda long, but it will help in keeping the documentation consistent. You will also find examples of
when to use specific features of mkdocs and mkdocs-material.
> [!WARNING]
> This repository is **no longer being maintained.**
> Our docs can now be found [here](https://gregtechceu.github.io/GregTech-Modern/).
>
> If you would like to contribute, view the instructions [on our main repository](https://github.com/GregTechCEu/GregTech-Modern/tree/1.20.1/docs)

0 comments on commit 2bff261

Please sign in to comment.