Skip to content

Getting started as a developer and as a user #163

@ChristopherRabotin

Description

@ChristopherRabotin

Description

As I try out Opensuse Aeon (an immutable OS akin to Fedora Silverblue), I realize that it isn't trivial to get started with development of Nyx: it requires Rust but also Python and a set of requirements. This should be in the documentation, and a devcontainer should also be provided.

For users, a docker image with the latest release and latest nightly builds of the Python library should be provided.

Documentation type

Tell us which of the four Diátaxis documentation types this issue or enhancement relates to:

  • Tutorial
  • How-to guide
  • Technical reference / Math Spec
  • Explanation

Affected area(s)

N/A in the online documentation does not refer to development at all.

Expected or desired behavior

A quick getting started on development.

Possible solutions (optional)

It would be very helpful to have a Dockerfile that has all of the requirements and even a VSCode devcontainer to onboard new developers in an instant.

Who should review this?

@ThibFrgsGmz (if desired), @gwbres (if desired), and me

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions