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

Documentation currently lacks a simple example. #381

Open
chadagreene opened this issue Jan 23, 2023 · 2 comments
Open

Documentation currently lacks a simple example. #381

chadagreene opened this issue Jan 23, 2023 · 2 comments

Comments

@chadagreene
Copy link

As a Julia newbie who's trying to learn how to create packages the right way, I find the current documentation for PkgTemplates doesn't offer much of an on-ramp for beginners. I cannot find any sort of "Follow these steps" for a simplest-case scenario of creating a package and linking it to GitHub. Instead, the docs skip straight to "A More Complicated Example", which is presented without context or explanation.

After tinkering a bit, I think I've found a process that works, which I've done my best to document here. But ideally, I'm hoping that someone who knows what they're doing can add a simple Minimal Working Example to the docs, explaining each step of how to create a package the proper way.

@nsajko
Copy link

nsajko commented Jan 27, 2023

TLDR: run generate() and the process is foolproof and interactive

@oxinabox
Copy link
Collaborator

There definately used to be an example template in the docs that had some common options you might like to play with.
We should bring that example back.
It is nice to have a basic Template to tweak

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

No branches or pull requests

3 participants