pony-stable icon indicating copy to clipboard operation
pony-stable copied to clipboard

Make getting started friendly

Open tbillington opened this issue 8 years ago • 5 comments
trafficstars

Currently neither the readme nor pony-stable provide/explain a way to initialise a project.

I had to look at other repos and projects in pony to find how to structure the bundle.json. It's not explained in the readme how to get started.

A common solution is to add an init command to pony-stable to initialise the config file as seen in other package managers.

tbillington avatar Nov 04 '17 04:11 tbillington

Running, stable add will create the required bundle.json. What would an init command do?

SeanTAllen avatar Nov 04 '17 16:11 SeanTAllen

Create a base bundle.json with no deps presumably.

I was confused by the content of the help command. It says to Invoke in a working directory containing a bundle.json but none of the commands mention the ability to create bundle.json. Perhaps the add command could mention that it will create the bundle.json if needed?

> stable help
Usage: stable COMMAND [...]

    A simple dependency manager for the Pony language.

    Invoke in a working directory containing a bundle.json.

Commands:
    help    - Print this message
    version - Print version information
    fetch   - Fetch/update the deps for this bundle
    env     - Execute the following shell command inside an environment
              with PONYPATH set to include deps directories. For example,
              `stable env ponyc myproject`
    add     - Add a new dependency. For exemple,
              `stable add github jemc/pony-inspect

tbillington avatar Nov 05 '17 09:11 tbillington

Can you open a PR for this?

SeanTAllen avatar Nov 05 '17 13:11 SeanTAllen

@SeanTAllen sure, how would you recommend changing it, something like:

Invoke in a working directory containing a bundle.json.

->

Invoke in a working directory containing a bundle.json.
Alternatively, adding a dependency will create a
bundle.json containing the dependency in the directory.

tbillington avatar Nov 09 '17 09:11 tbillington

I would also love to see the initialization command. it would be cool to set the package version and name In bundle.json on init step (with user prompt)

Akiyamka avatar Apr 26 '20 10:04 Akiyamka