Meta materials

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+    contents: write
+
+jobs:
+  Build-And-Deploy:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup Rust
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        override: true
+        components: rust-docs
+
+    - name: Generate Documentation
+      run: |
+        cargo doc --no-deps --all-features
+        echo "<meta http-equiv=\"refresh\" content=\"0; url=rusty_ache/index.html\">" > target/doc/index.html
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./target/doc
+        publish_branch: docs
+        force_orphan: true

CONTRIBUTING.md

@@ -0,0 +1,88 @@
+# Contributing to rusty_ache
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
+
+## Table of Contents
+
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+- [Reporting Bugs](#reporting-bugs)
+- [Suggesting Enhancements](#suggesting-enhancements)
+
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available [documentation](https://p1onerka.github.io/rusty_ache/rusty_ache/index.html).
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/p1onerka/rusty_ache/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an [Issue](https://github.com/p1onerka/rusty_ache/issues/new).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions, depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+## I Want To Contribute
+
+> ### Legal Notice
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
+
+### Reporting Bugs
+
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://p1onerka.github.io/rusty_ache/rusty_ache/index.html). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
+- Collect information about the bug:
+    - Stack trace (Traceback)
+    - OS, Platform and Version (Windows, Linux, macOS, x86, ARM).
+    - Version of the compiler, SDK, runtime environment, depending on what seems relevant.
+    - Possibly your input and the output.
+    - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to xeniia.ka@gmail.com.
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/p1onerka/rusty_ache/issues/new).
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. For good bug reports you should isolate the problem and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be implemented by someone.
+
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for *rusty_ache* including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://p1onerka.github.io/rusty_ache/rusty_ache/index.html) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/p1onerka/rusty_ache/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/p1onerka/rusty_ache/issues).
+
+- Use a clear and descriptive title for the issue to identify the suggestion.
+- Provide a step-by-step description of the suggested enhancement in as many details as possible.
+- Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
+- You may want to include screenshots or screen recordings which help you demonstrate the steps or point out the part which the suggestion is related to.
+- Explain why this enhancement would be useful to most *rusty_ache* users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+## Attribution
+This guide is based on the [contributing.md](https://contributing.md/generator)!

Cargo.toml

@@ -2,6 +2,8 @@
 name = "rusty_ache"
 version = "0.1.0"
 edition = "2024"
+documentation = "https://p1onerka.github.io/rusty_ache"
+repository = "https://github.com/p1onerka/rusty_ache"
 
 [[bin]]
 name = "main"
@@ -12,3 +14,6 @@ path = "src/bin/main.rs"
 image = "0.25.8"
 pixels = "0.15.0"
 winit = "0.30.12"
+
+[package.metadata.docs.rs]
+all-features = true

README.md

@@ -1,2 +1,25 @@
 # rusty_ache
 Blazingly fast game engine written in Rust.
+
+## How to run
+Clone this repo:
+```bash
+  git clone git@github.com:WoWaster/Geraltt.git
+```
+Open project:
+```bash
+  cd spbu-tt-diff-notify
+```
+Run project:
+```bash
+  cargo run --bin main
+```
+
+### Docs
+Project documentation is availible [here](https://p1onerka.github.io/rusty_ache/rusty_ache/index.html).
+
+## Devs
+* [Aleksei Dmitrievstev](https://github.com/admitrievtsev)
+* [Ksenia Kotelnikova](https://github.com/p1onerka)
+* [Sofya Kozyreva](https://github.com/sofyak0zyreva)
+* [Kostya Oreshin](https://github.com/sevenbunu)