Skip to content

Commit

Permalink
Merge pull request #124 from 0xnim/rewrite/housekeeping
Browse files Browse the repository at this point in the history
Small updates to housekeeping
  • Loading branch information
ReCore-sys authored Nov 13, 2024
2 parents 68ee9f5 + 997bc7b commit 38f6acd
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 3 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ who have you discussed this with, etc. If these questions were answered in a con
you talked with and what consensus was reached. Unexplained PRs will rarely be accepted.
4. Check again that tests pass.
5. Check a 3rd time.
6. Submit PR.
6. Check that Clippy passes with no issues. `cargo clippy --all-targets -- -Dwarnings` is used on CI.
7. Submit PR.

## Project specific guidelines
Just some rules to try to keep the repo nice and organised
Expand All @@ -27,7 +28,7 @@ made to the dev branch. This branch should be branched off of the dev branch.
#### `fix/fixed-thing`
This branch is for fixing a bug. Once the bug is fixed, a PR should be made to the dev
branch. This branch should be branched off of the dev branch.
#### `refactor/refactored-thing`
#### `rework/refactored-thing`
This branch is for refactoring code. Once the code is refactored, a PR should be made to the dev branch.
#### `housekeeping`
This branch is for stuff relating to the repo itself. This could be updating the README, adding
Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,23 @@ etc. live) by setting an environment variable `FERRUMC_ROOT` to the path of the
`set FERRUMC_ROOT=C:\Users\ReCor\Documents\Code\Rust\ferrumc` before running the server. This is useful if you
can't move the place the binary is executed from (`cargo run` for example).*

---

## Nightly Dev Server

There is a nightly deployed version of rewrite/v3 running at `ferrumc.nimq.xyz`.

## Docs

Documentation for rewrite/v3 can be found at:

- Unsecure https://docs.ferrumc.com/
- HTTPS https://docs.nimq.xyz/

## Funding / Donations

If you would like to donate to the development of FerrumC, you can do so via the following methods:

- OpenCollective: https://opencollective.com/ferrumc


2 changes: 1 addition & 1 deletion assets/plans/plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@


- [ ] Database
- [x] [redb](https://www.redb.org/)
- [ ] [LMDB](https://en.wikipedia.org/wiki/Lightning_Memory-Mapped_Database) (K/V Store)
- [ ] Hash(key) => Value

Expand All @@ -58,7 +59,6 @@
- [x] Auto init with reflections
- [ ] support multiple versions (map versions packet id etc)


- [ ] Redstone
- [ ] Compile redstone, lightweight impl (fast & accurate)

Expand Down

0 comments on commit 38f6acd

Please sign in to comment.