devraza/ambition
devraza/ambition
Archived
1
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

docs: update README.md

Browse source 
Former-commit-id: cc1c569e0eec971ccdc44a25f02985e560048076
This commit is contained in:
Muhammad Nauman Raza 2023-11-27 22:54:38 +00:00
parent fd9ee79e4f
commit 8441f0deb4
Signed by: devraza
GPG key ID: 91EAD6081011574B
1 changed files with 10 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -1,35 +1,16 @@
<div align=center> *Go forth and realise your...*
# ❄️ nix-template-rust-nightly 🦀 # Ambition
[![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**
</div>
## About ## 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 ## License
with the following command in your current directory. See the [LICENSE](LICENSE) for a copy of the Apache License 2.0
```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/<name>`
- `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)