Skip to content

Commit 6c0c39d

Browse files
authored
Update README.md
1 parent 0cb6aa7 commit 6c0c39d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,19 @@ As of now, only the Windows, Linux and Android versions have been tested. Androi
5454
![caly preview 2](https://github.com/user-attachments/assets/f850dc94-cefb-43c7-b856-acd34e2fc373)
5555

5656
## Getting Started
57+
### `master` branch
58+
The `master` branch of Caly Pdf Reader uses NuGet packages. You can ignore the `external` folder.
5759

58-
Caly Pdf Reader uses submodules, you will need to run the following command after cloning it:
60+
### `develop` branch
61+
The `develop` branch of Caly Pdf Reader uses submodules (located in the `external` folder), you will need to run the following command after cloning it:
5962
```
6063
git submodule update --init --recursive
6164
```
6265

6366
> [!IMPORTANT]
6467
> If the submodule branches appear as 'detached', you can re-link each of them to their respective `develop-caly` branches.
6568
69+
### Publishing
6670
Caly Pdf Reader is a net8.0 application with Native AOT (ahead of time compilation) enabled. To publish the application, run the following (example for Windows):
6771
```
6872
dotnet publish -r win-x64 -c Release -f net8.0

0 commit comments

Comments
 (0)