halcyon icon indicating copy to clipboard operation
halcyon copied to clipboard

Published 20 hours ago • verified publisher icon selfhostedshow

Document how to build the app for devs

Open ironicbadger opened this issue 5 years ago • 3 comments

This issue is aimed at helping people who want to build the app and develop the app be able to get started.

ironicbadger avatar Oct 10 '20 19:10 ironicbadger

In theory, this should always be as simple as git clone, cargo build / cargo run.

Some documentation on how to run tests (cargo test), and what checks we run (cargo fmt, clippy etc) is probably also useful.

This should live in the readme, and be as short as possible. eg we should not be documenting how to install rust / clippy.

RealOrangeOne avatar Oct 10 '20 20:10 RealOrangeOne

I'll happily help with this.

Start with a MVP that's basically possible to cut and paste for Fedora and Ubuntu?

Landrash avatar Oct 11 '20 07:10 Landrash

@Landrash that'd be great!

Yeah pretty much, the instructions should be 100% distro agnostic, and we can link out to say the rust installation guide for anything specific like that.

super simple!

RealOrangeOne avatar Oct 11 '20 10:10 RealOrangeOne