Skip to content

Commit 42efb17

Browse files
committed
docs: add git submodule init step to setup instructions
1 parent 5926d0b commit 42efb17

2 files changed

Lines changed: 14 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,9 @@ Submersion is built on these principles:
134134
git clone https://github.com/submersion-app/submersion.git
135135
cd submersion
136136

137+
# Initialize submodules (required for libdivecomputer)
138+
git submodule update --init --recursive
139+
137140
# Install dependencies
138141
flutter pub get
139142

@@ -292,9 +295,10 @@ See [FEATURE_ROADMAP.md](FEATURE_ROADMAP.md) for the complete development plan.
292295
Contributions are welcome! Submersion is built by divers, for divers.
293296

294297
1. Fork the repository
295-
2. Create a feature branch: `git checkout -b feature/your-feature`
296-
3. Make your changes with tests
297-
4. Submit a pull request
298+
2. Clone and initialize submodules: `git clone --recurse-submodules <your-fork-url>`
299+
3. Create a feature branch: `git checkout -b feature/your-feature`
300+
4. Make your changes with tests
301+
5. Submit a pull request
298302

299303
Please run `flutter analyze` and `flutter test` before submitting.
300304

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ Full support for UDDF, CSV, and PDF export. Import from other dive log apps. Com
8282
git clone https://github.com/submersion-app/submersion.git
8383
cd submersion
8484

85+
# Initialize submodules (required for libdivecomputer)
86+
git submodule update --init --recursive
87+
8588
# Install dependencies
8689
flutter pub get
8790

@@ -97,6 +100,7 @@ flutter run -d macos
97100
# Clone and setup
98101
git clone https://github.com/submersion-app/submersion.git
99102
cd submersion
103+
git submodule update --init --recursive
100104
flutter pub get
101105
dart run build_runner build --delete-conflicting-outputs
102106

@@ -112,6 +116,7 @@ flutter run -d ios
112116
# Clone and setup
113117
git clone https://github.com/submersion-app/submersion.git
114118
cd submersion
119+
git submodule update --init --recursive
115120
flutter pub get
116121
dart run build_runner build --delete-conflicting-outputs
117122

@@ -124,6 +129,7 @@ flutter run -d android
124129
# Clone and setup
125130
git clone https://github.com/submersion-app/submersion.git
126131
cd submersion
132+
git submodule update --init --recursive
127133
flutter pub get
128134
dart run build_runner build --delete-conflicting-outputs
129135

@@ -136,6 +142,7 @@ flutter run -d windows
136142
# Clone and setup
137143
git clone https://github.com/submersion-app/submersion.git
138144
cd submersion
145+
git submodule update --init --recursive
139146
flutter pub get
140147
dart run build_runner build --delete-conflicting-outputs
141148

0 commit comments

Comments
 (0)