Skip to content

Commit c71bdaa

Browse files
committed
update readme
1 parent 1896b1f commit c71bdaa

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To execute your tests via command line in Continues Integration (CI), you can us
2525
- Open the CMD there.
2626
- Execute the following command:
2727

28-
`bellatrix <path>`
28+
bellatrix <path>
2929

3030
where path is an optional argument for a path to the tests folder, either relative or absolute.
3131

@@ -49,35 +49,35 @@ To leverage a specific version of BELLATRIX in your project, you can add it as a
4949
Navigate to Your Project Directory: Open a terminal and change to the directory where your project is located.
5050
Add BELLATRIX as a Submodule: Use the following Git command to add BELLATRIX as a submodule to your project:
5151

52-
`git submodule add https://github.com/BELLATRIX-Library/BELLATRIX.git path/to/submodule`
52+
git submodule add https://github.com/BELLATRIX-Library/BELLATRIX.git path/to/submodule
5353

5454
Replace path/to/submodule with the relative path within your project where you'd like the BELLATRIX submodule to reside. Initialize and Clone the Submodule: If you're adding the submodule for the first time, initialize your local configuration file and clone the BELLATRIX repository as follows:
5555

56-
`git submodule update --init --recursive`
56+
git submodule update --init --recursive
5757

5858
Checking Out a Specific Tag (Release Version)
5959

6060
After adding BELLATRIX as a submodule, you might want to use a specific release version rather than the latest commit on the main branch.
6161

6262
Navigate to the Submodule Directory: Change into the BELLATRIX submodule directory within your project:
6363

64-
`cd path/to/submodule`
64+
cd path/to/submodule
6565

6666
Fetch All Tags from the BELLATRIX Repository: To ensure you have a list of all available tags, fetch them:
6767

68-
`git fetch --tags`
68+
git fetch --tags
6969

7070
Checkout the Desired Tag: Check out the specific tag (release version) you want to use by replacing <tagname> with the desired version:
7171

72-
`git checkout tags/<tagname>`
72+
git checkout tags/<tagname>
7373

7474
For example, if you want to check out version v3.9.0.0, you would use: git checkout tags/v3.9.0.0
7575

7676
Commit the Submodule Change: Navigate back to your project's root directory, and commit the change to the submodule reference:
7777

78-
`cd ../..`
79-
`git add path/to/submodule`
80-
`git commit -m "Update BELLATRIX submodule to v3.9.0.0"`
78+
cd ../..
79+
git add path/to/submodule
80+
git commit -m "Update BELLATRIX submodule to v3.9.0.0"
8181

8282
This process ensures that your project uses a specific, fixed version of BELLATRIX, providing stability and consistency across environments or deployments.
8383
Contributing to Our Project

0 commit comments

Comments
 (0)