From 8441f0deb4af2465e807604563fec2ca040a23a5 Mon Sep 17 00:00:00 2001 From: Muhammad Nauman Raza Date: Mon, 27 Nov 2023 22:54:38 +0000 Subject: [PATCH] docs: update README.md Former-commit-id: cc1c569e0eec971ccdc44a25f02985e560048076 --- README.md | 39 ++++++++++----------------------------- 1 file changed, 10 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index ffc3f02..67fc676 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,16 @@ -
+*Go forth and realise your...* -# ❄️ nix-template-rust-nightly 🦀 - -[![NixOS](https://img.shields.io/badge/Made_for-Rust-orange.svg?logo=rust&style=for-the-badge)](https://www.rust-lang.org/) [![NixOS](https://img.shields.io/badge/Flakes-Nix-informational.svg?logo=nixos&style=for-the-badge)](https://nixos.org) ![License](https://img.shields.io/github/license/mordragt/nix-templates?style=for-the-badge) - -Minimal **Rust** development template for **Nix** - -
+# Ambition ## About +Ambition is a fast-paced, textual 2D multiplayer role-playing game written in Rust. -This is a minimal template for Rust development on the nightly channel. +## Credits +- [Muhammad Nauman Raza](https://github.com/devraza) - Project Manager/Founder, Producer, and Programmer +- [Abdulmujeeb Raji](https://github.com/midnadimple) - Programmer and Game Designer -## Initialization +## Acknowledgements +- [Adam Khan](https://github.com/krasket) - (Former) UI/UX designer -See the parent README for further instructions, but you can initialize this template -with the following command in your current directory. - -```bash -nix flake init -t github:MordragT/nix-templates#rust-nightly -``` - -## Usage - -- `nix develop`: opens up a `bash` shell with the bare minimum Rust toolset (`cargo` & `rustc`) by default -- `nix build` : builds the Rust project. Outputs the binary to `./result/bin/` -- `nix run`: runs the Rust program. - - -## Reference - -1. [wiki/Flakes](https://nixos.wiki/wiki/Flakes) -2. [Fenix](https://github.com/nix-community/fenix) - used for managing Rust toolchains (read the `makeRustPlatform` example) -3. [rust-section of language frameworks](https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/rust.section.md#cargo-features-cargo-features) - optional (use it for extending the template) \ No newline at end of file +## License +See the [LICENSE](LICENSE) for a copy of the Apache License 2.0