Giter Site home page Giter Site logo

Comments (1)

NickleDave avatar NickleDave commented on June 26, 2024

Thank you @ItamarFruchter for catching this and sorry again for the inconvenience

We need to do two things here:

  • fix that sections of "setting up a dev environment" to explain nox usage
  • also explain nox usage in other parts of that page, e.g. how to run tests + build docs

The "setting up a dev environment" should be updated like so

as a developer

This project uses the library nox
as a task runner,
to automate tasks like setting up a development environment.
Each task is represented as what nox calls a "session",
and you can run a session by invoking nox
at the command-line with the name of the session.

So, to set up a virtual environment for development
with songdkl installed in "editable" mode,
run the "dev" session.

(copying from 'songdkl` README: https://raw.githubusercontent.com/NickleDave/songdkl/main/README.md)

We suggest using pipx
to install nox in an isolated environment,
so that nox can be accessed system-wide without affecting
anything else on your machine.

  1. Install pipx, e.g. with brew
    (and brew works on Linux too)
  2. Install nox with pipx: pipx install nox
  3. Use nox to run the dev session: nox -s dev
  4. Activate the virtual environment: . ./.venv/bin/activate (and/or tell your IDE to use it)

from vak.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.