Skip to content

Commit 9e39233

Browse files
committed
Added the set-up for the initial_set_up function and minor changes on the calls of the functions.
1 parent c61876a commit 9e39233

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,8 @@ It includes detailed guides in Italian, English, and German, additionally, you c
7272
You can find a simple and easy documentation below:
7373

7474
The tool requires the directory structure shown above.
75-
After opening a terminal in the project’s source directory (which contains the `data/` and `src/` folders), run the command `easy_versioning_build`.
75+
You can use the `easy-versioning-setup` command to set up the folders with the correct layout for an easy-versioning project. This function takes two parameters as input: the project name and the author name, which are used to set up the Sphinx project, if no arguments are provided the default name is gonna be "Documentation" and the author "Author".
76+
After opening a terminal in the project’s source directory (which contains the `data/` and `src/` folders), run the command `easy-versioning-build` to build your project.
7677

7778
This command can be run without any arguments, or with up to two arguments:
7879

@@ -81,8 +82,8 @@ This command can be run without any arguments, or with up to two arguments:
8182
- Set this flag to `0` to disable cleanup and keep the `_source` directory.
8283

8384
Examples:
84-
- `easy_versioning_build` — Uses English as the default language and removes the `_source` directory.
85-
- `easy_versioning_build Italiano 0` — Sets Italian as the default language and keeps the `_source` directory intact.
85+
- `easy-versioning-build` — Uses English as the default language and removes the `_source` directory.
86+
- `easy-versioning-build Italiano 0` — Sets Italian as the default language and keeps the `_source` directory intact.
8687

8788
---
8889

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ packages = ["easy_versioning"]
2929
"easy_versioning" = ["data/*"]
3030

3131
[project.scripts]
32-
easy_versioning_build = "easy_versioning.main:easy_versioning_build"
32+
easy-versioning-build = "easy_versioning.main:easy_versioning_build"
33+
easy-versioning-setup = "easy_versioning.main:initial_set_up"
3334

3435

0 commit comments

Comments
 (0)