diff options
| author | Fuwn <[email protected]> | 2024-06-12 04:29:19 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-06-12 04:29:19 -0700 |
| commit | 7c0b90eb2904b39eb896bbaa6a249bff61b58f72 (patch) | |
| tree | 3496ae55235c6ced0df2848d64cadabe6ed827b0 | |
| parent | refactor(command): clearer field names (diff) | |
| download | whirl-7c0b90eb2904b39eb896bbaa6a249bff61b58f72.tar.xz whirl-7c0b90eb2904b39eb896bbaa6a249bff61b58f72.zip | |
docs(readme): clean up
| -rw-r--r-- | README.rst | 68 |
1 files changed, 12 insertions, 56 deletions
@@ -5,37 +5,23 @@ <img src="https://raw.githubusercontent.com/Whirlsplash/assets/master/Whirl.png" alt="Whirl" - width="220"> + width="200"> </a> </p> - <h1 align="center">The Open-Source WorldServer</h1> - <h3 align="center">A Worlds united</h3> + <h1 align="center">Whirl: The Open-Source WorldServer</h1> + <h3 align="center">A Worlds United</h3> - <p align="center"> - -.. image:: https://img.shields.io/discord/821938182274154506 - :alt: Discord - :target: https://discord.com/invite/8hn6padWF6 - -.. image:: https://www.codefactor.io/repository/github/whirlsplash/whirl/badge - :alt: CodeFactor - :target: https://www.codefactor.io/repository/github/whirlsplash/whirl + <br> -.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg - :alt: Say Thanks - :target: https://saythanks.io/to/[email protected] - -.. image:: https://img.shields.io/github/license/Whirlsplash/whirl - :alt: License - :target: ./LICENSE + <p align="center"> .. raw:: html </p> -Whirl, an open-source implementation of the +Whirl is an open-source implementation of `Worlds <https://www.worlds.com/>`_' `WorldServer <http://dev.worlds.net/private/GammaDocs/WorldServer.html>`_ -protocol in `Rust <https://www.rust-lang.org/>`_. +protocol, written in the modern and safe `Rust <https://www.rust-lang.org/>`_. Purpose ------- @@ -45,7 +31,7 @@ Two *main* reasons; 1. Worlds' official servers are old, slowly deteriorating, and *probably* unmaintained. 2. Worlds is **old**; the shutdown of the servers is inevitable. -**TLDR**: To keep Worlds' legacy going for future generations. +**TLDR**: To keep Worlds' legacy alive for future generations. Usage ----- @@ -63,23 +49,13 @@ Documentation about the entire Whirlsplash ecosystem can be found `here <https://whirlsplash.org/docs/>`_. If you are looking for explicit documentation of only Whirl's source code, you -must generate them yourself be cloning the repository and running the Cargo -subcommand; +may generate them yourself be cloning the repository and running the `doc` Cargo +subcommand: .. code-block:: shell $ cargo +nightly doc --open --document-private-items --no-deps # or `cargo make gen-docs` -Known Issues ------------- - -- https://github.com/Whirlsplash/whirl/issues/2 - -Contributing ------------- - -Please reference the `contribution guidelines <./CONTRIBUTING.md>`_ of this repository. - Development Dependencies ------------------------ @@ -98,27 +74,7 @@ Optional - `sqlfluff <https://github.com/sqlfluff/sqlfluff>`_ — SQL linting - `Valgrind <https://www.valgrind.org/>`_ — Benchmarking -*These development dependencies (excluding sqlfluff) will automatically be satisfied if you are -using the Nix shell configuration as provided.* - -Benchmarking ------------- - -For the time being; benchmarking is only available for \*nix-based environments as the benchmarking -utility currently in place, `Iai <https://github.com/bheisler/iai>`_, has a hard dependency on -`Valgrind <https://www.valgrind.org/>`_ which is only accessible within \*nix-based environments. - -More so, the current benchmarks which have been set-up do not cover the full extent of Whirl, but a -small portion of the crates which make up Whirl as a whole. In the future, benchmarks may be -expanded upon. - -To execute the available benchmarks, use the following Cargo subcommand; - -.. code-block:: shell - - $ cargo bench - -License +Licence ~~~~~~~ -`GNU General Public License v3.0 <./LICENSE>`_ +This project is licensed with the `GNU General Public License v3.0 <./LICENSE>`_. |