Briefly explain the files/folders in the template and the generated package

[fdiblen]

Description

Some users/developers may not be familiar with the files and/or project structure. It would helps users and developers if we have brief description for the template and the generated package.

For example for the generated package a user would have to following:

├── CITATION.cff
├── docs
│   ├── make.jl
│   ├── Project.toml
│   └── src
├── LICENSE
├── lychee.toml
├── Project.toml
├── README.md
├── src
│   └── JohnConnor.jl
└── test
    ├── Project.toml
    └── runtests.jl

The description could be:

• ...
• docs: this folder contains the documentation of the project.
  • make.jl generates and deploys the documentation
  • ...
• test: this folder contains the tests of the package
  • runtests.jl: you can add your unit tests in this file
  • ...
• ...

[abelsiqueira]

There is some info in the Explanation section of the docs, I don't know if you had found that yet.

If yes, then you think this fits there?

If no, then what would have made it easier to find this section?

[Kiunga1]

Here is a simple explanation of files/folders in the template and the generated package

Generated Package Structure Explained:

• CITATION.cff: Helps others properly cite your package in academic papers.
• docs/:
  • make.jl: This script creates and shares the project's documentation.
  • Project.toml: Lists what other software your package needs to run.
  • src/: Holds files used to make the documentation.
• LICENSE: Explains how people can use and share your package.
• lychee.toml: A setup file just for your project.
• Project.toml: Lists what other software your package needs to run.
• README.md: A guide that explains your package and how to use it.
• src/: Holds most of your code.
  • JohnConnor.jl: An example of what your package does.
• test/:
  • Project.toml: Lists what other software your tests need.
  • runtests.jl: A script that tests how well your package works.

This setup helps anyone who wants to use or work on your package understand how everything is organized and find what they need easily.

Resource
GitHub Documentation:

GitHub Guides on Repository Structure - Explains the basic structure of GitHub repositories, including files like README.md, LICENSE, and directories like docs, src, and test.

[abelsiqueira]

Hi @Kiunga1, thanks for the comment, but I'm not sure these are Julia specific comments. Are you using the template? Sorry to ask this, but is this comment generated by AI (e.g., ChatGPT)?

[abelsiqueira]

There is some explanation, if it's not enough we can reopen this issue.