Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jurajhilje committed Oct 27, 2023
1 parent 9d3e262 commit 76136c9
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Project dev dependencies:
Install fastlane, SwiftLint and Go:

```sh
$ brew install fastlane swiftlint go
brew install fastlane swiftlint go
```

### Dependencies
Expand All @@ -73,24 +73,32 @@ There are different build configurations: Staging and Release.
Rename and populate `.xcconfig` files:

```sh
$ cp IVPNClient/Config/staging.template.xcconfig IVPNClient/Config/staging.xcconfig
$ cp IVPNClient/Config/release.template.xcconfig IVPNClient/Config/release.xcconfig
cp IVPNClient/Config/staging.template.xcconfig IVPNClient/Config/staging.xcconfig
cp IVPNClient/Config/release.template.xcconfig IVPNClient/Config/release.xcconfig
```

### OpenVPN configuration

Rename and populate `OpenVPNConf.swift` file:

```sh
$ cp IVPNClient/Config/OpenVPNConf.template.swift IVPNClient/Config/OpenVPNConf.swift
cp IVPNClient/Config/OpenVPNConf.template.swift IVPNClient/Config/OpenVPNConf.swift
```

### Build V2RayControl.xcframework

Build `V2RayControl.xcframework`:

```sh
./build.sh
```

### Fastlane configuration

Rename and populate `Appfile` files:

```sh
$ cp fastlane/Appfile.template fastlane/Appfile
cp fastlane/Appfile.template fastlane/Appfile
```

<a name="testing"></a>
Expand All @@ -99,19 +107,19 @@ $ cp fastlane/Appfile.template fastlane/Appfile
Run code linter using fastlane:

```sh
$ fastlane lint
fastlane lint
```

Run tests using fastlane:

```sh
$ fastlane test
fastlane test
```

Alternatively, run tests using xcodebuild:

```sh
$ xcodebuild test -scheme IVPNClient -destination 'platform=iOS Simulator,name=iPhone 14'
xcodebuild test -scheme IVPNClient -destination 'platform=iOS Simulator,name=iPhone 14'
```

<a name="deployment"></a>
Expand All @@ -120,19 +128,19 @@ $ xcodebuild test -scheme IVPNClient -destination 'platform=iOS Simulator,name=i
To build and deploy beta build to TestFlight:

```sh
$ fastlane beta
fastlane beta
```

To build and deploy staging build to TestFlight:

```sh
$ fastlane staging
fastlane staging
```

To build and deploy App Store release build to TestFlight:

```sh
$ fastlane release
fastlane release
```

<a name="versioning"></a>
Expand Down

0 comments on commit 76136c9

Please sign in to comment.