Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.85 KB

first-time-huh.md

File metadata and controls

29 lines (18 loc) · 1.85 KB

First time contributing

first time meme

So, you want to give me feedback for my little app? 🤓

🧛🏻 Vampire-Charact-rs is a character sheet management tool for Vampire the Masquerade 5th edition, "V5" 🧛🏻. At the time of writing, the tool is still at the early stages of development. Eventually I'd like to build something like The One App, a character management app that is even available for Android.

At the moment, vampire-charact-rs is just a command-line tool with limited functionality.

Instructions

If you want to help me test it, you'll have to learn how to compile rust code ⚙️ 🛠️ That isn't terribly difficult: follow the instructions here: install rust (if you're on Linux, use your package manager! For Windows or Mac, the installation guide you'll be shown on that page will probably be the best way). For more information check out the Rust Book's Installation section.

The rest should be simple from here: clone my repository on Github 💻 (or, if you don't have git, download the zip archive 📂 and extract it somewhere). In the extracted folder, execute the commands as described in my README.

And then, give feedback! 🗣️

"doesn't work", "how do I do this, I don't understand", "this is cool, could you add..." is all welcome!

If you want to, I will add your name to the list of Acknowledgements... or maybe to some Easter egg feature ☺️

Note for beginners: If you're annoyed by the cargo output "Finished release profile..." etc., you can disable it per run with the -q flag, or permanently. See cargo help run for information.