Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Getting started as a developer and as a user #163

Open
ChristopherRabotin opened this issue Jun 4, 2023 · 0 comments
Open

Getting started as a developer and as a user #163

ChristopherRabotin opened this issue Jun 4, 2023 · 0 comments

Comments

@ChristopherRabotin
Copy link
Member

ChristopherRabotin commented Jun 4, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant