search

selfhostedshow / halcyon

Home Assistant Linux Companion
https://halcyon.casa/
45 stars 4 forks source link

Document how to build the app for devs #9

Open ironicbadger opened 3 years ago

ironicbadger commented 3 years ago

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

RealOrangeOne commented 3 years ago

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.

Landrash commented 3 years ago

I'll happily help with this.

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

RealOrangeOne commented 3 years ago

@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!