arkham/docs/overview/getting-started.md

title	subtitle	menu_position
Getting Started	Overview	0

Starting a new project

To setup a new project use cargo new and cargo add arkham to add the dependency.

cargo new my_project
cd my_project
cago add arkham

Import the arkham prelude

Add the following line to the top of my_project/src/main.rs to import all the Arkham members.

use arkham::prelude::*;

Setup the root view

Arkham requires a Root View component that will act as a container view for the application. Views in Arkham are simple functions. We can add a root view function to my_project/src/main.rs A simple root view may look like this:

fn root_view(ctx &mut ViewContext) {
    ctx.insert((5,5), "Hello World");
}

Setup the application

In our main function we can setup the application and run it, beginning the run loop. Replace the main function in my_project/src/main.rs with the following:

fn main() {
    App::new(root_view).run().unwrap();
}

The full main.rs

The full main.rs now looks like this:

use arkham::prelude::*;

fn main() {
    App::new(root_view).run().unwrap();
}

fn root_view(ctx &mut ViewContext) {
    ctx.insert((5,5), "Hello World");
}

This can now be run with cargo run and a hello world app, complete with a default 'q' hotkey to quit, will run.