swift/Beam
swift/Beam
1
0
Fork 0
mirror of https://github.com/element-hq/element-x-ios.git synced 2025-03-10 21:39:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation files (#313)

Browse Source 
* Updated md files

* Changelog

* Update CONTRIBUTING.md

Co-authored-by: Stefan Ceriu <stefanc@matrix.org>

* PR fixes

* Update README.md

Co-authored-by: Stefan Ceriu <stefanc@matrix.org>

Co-authored-by: Stefan Ceriu <stefanc@matrix.org>
This commit is contained in:
Aleksandrs Proskurins 2022-11-15 11:49:13 +02:00 committed by GitHub
parent 2e56fe9380
commit 1c4dc89627
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -50,7 +50,7 @@ Please see our [pull request guide](https://github.com/vector-im/element-android
## Implementing a new screen
New screen flows are currently using MVVM-Coordinator pattern. Please refer to the screen template under [Tools/Scripts/createScreen.sh](Tools/Scripts/createScreen.sh) to create a new screen or a new screen flow.
New screen flows are currently using the MVVM-Coordinator pattern. Please refer to the [create screen template](Tools/Scripts/README.md#create-screen-templates) section.
## Changelog

4
README.md
View File

@ -33,6 +33,10 @@ Please see our [contribution guide](CONTRIBUTING.md).
Come chat with the community in the dedicated Matrix [room](https://matrix.to/#/#element-ios:matrix.org).
## Build instructions
Please refer to the [setting up a development environment](CONTRIBUTING.md#setting-up-a-development-environment) section from the [contribution guide](CONTRIBUTING.md).
## Support
When you are experiencing an issue on ElementX iOS, please first search in [GitHub issues](https://github.com/vector-im/element-x-ios/issues)

16
Tools/Scripts/README.md
View File

@ -23,3 +23,19 @@ Usage:
```
./bootTestSimulator.py 'iPhone 13 Pro Max'
```
## Create screen templates
New screen flows are currently using the MVVM-Coordinator pattern. Run [Tools/Scripts/createScreen.sh](Tools/Scripts/createScreen.sh) to create a new screen and all its required dependencies.
Usage:
```
./createScreen.sh Folder MyScreenName
```
After that run `xcodegen` to regenerate the project.
`createScreen.sh` script will create:
- `Folder` within the `/ElementX/Sources/Screens/`. Files inside will be named `MyScreenNameXxx`.
- `MyScreenNameScreenUITests.swift` within `UITests/Sources`
- `MyScreenNameViewModelTests.swift` within `UnitTests/Sources/Unit`

2
Tools/Scripts/createScreen.sh
View File

@ -1,7 +1,7 @@
#!/bin/bash
if [ ! $# -eq 2 ]; then
echo "Usage: ./createSwiftUISimpleScreen.sh Folder MyScreenName"
echo "Usage: ./createScreen.sh Folder MyScreenName"
exit 1
fi

1
changelog.d/312.doc Normal file
View File

@ -0,0 +1 @@
Updated some documentation files.