Skip to content

Commit b0c0207

Browse files
authored
Merge pull request nightscout#559 from ebouchut-aps/fix/broken_link_in_README
📝 Update README with new domain links and unified formatting
2 parents 9221789 + b823dd4 commit b0c0207

1 file changed

Lines changed: 34 additions & 31 deletions

File tree

README.md

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You can either use the Build Script or you can run each command manually.
1616

1717
### Build Script:
1818

19-
If you copy, paste, and run the following script in Terminal, it will guide you through downloading and installing Trio. More information about the script can be found [here](https://docs.diy-trio.org/operate/build/#build-trio-with-script).
19+
If you copy, paste, and run the following script in Terminal, it will guide you through downloading and installing Trio. More information about the script can be found [here](https://triodocs.org/0.2.x/operate/build/#build-trio-with-script).
2020

2121
```
2222
/bin/bash -c "$(curl -fsSL \
@@ -34,67 +34,70 @@ git clone --branch=<branch> --recurse-submodules https://github.com/nightscout/T
3434
Create a ConfigOverride.xcconfig file that contains your Apple Developer ID (something like `123A4BCDE5`). This will automate signing of the build targets in Xcode:
3535

3636
Copy the command below, and replace `xxxxxxxxxx` by your Apple Developer ID before running the command in Terminal.
37+
3738
```
3839
echo 'DEVELOPER_TEAM = xxxxxxxxxx' > ConfigOverride.xcconfig
3940
```
4041

4142
Then launch Xcode and build the Trio app:
43+
4244
```
4345
xed .
4446
```
4547

4648
## To build directly in GitHub, without using Xcode:
4749

48-
Instructions:
50+
**Instructions**:
4951

50-
For main branch:
51-
* https://github.com/nightscout/Trio/blob/main/fastlane/testflight.md
52+
- For **`main`** branch:
53+
https://github.com/nightscout/Trio/blob/main/fastlane/testflight.md
54+
- For **`dev`** branch:
55+
https://github.com/nightscout/Trio/blob/dev/fastlane/testflight.md
5256

53-
For dev branch:
54-
* https://github.com/nightscout/Trio/blob/dev/fastlane/testflight.md
57+
Instructions in **greater detail**, but **not Trio-specific**:
5558

56-
Instructions in greater detail, but not Trio-specific:
57-
* https://loopkit.github.io/loopdocs/gh-actions/gh-overview/
59+
- https://loopkit.github.io/loopdocs/gh-actions/gh-overview/
5860

5961
## Please understand that Trio is:
62+
6063
- an open-source system developed by enthusiasts and for use at your own risk
6164
- not CE or FDA approved for therapy.
6265

66+
## Documentation
6367

64-
# Documentation
65-
66-
[Discord Trio - Server ](http://discord.triodocs.org)
67-
68-
[Trio documentation](https://triodocs.org/)
68+
- [Discord Trio - Server ](https://discord.triodocs.org/)
69+
- [Trio documentation](https://triodocs.org/)
70+
- [OpenAPS documentation](https://openaps.readthedocs.io/en/latest/)
71+
- [Crowdin](https://crowdin.triodocs.org/) is the collaborative platform we are using to manage the **translation** and localization of the Trio App.
72+
<!-- TODO: Add status graphic for the Crowdin Project -->
6973

70-
TODO: Add link: Trio Website (under development, not existing yet)
74+
## Support
7175

72-
[OpenAPS documentation](https://openaps.readthedocs.io/en/latest/)
76+
- [Trio Facebook Group](https://facebook.triodocs.org/)
77+
- [Loop and Learn Facebook Group](https://m.facebook.com/groups/LOOPandLEARN/)
78+
- [Looped Facebook Group](https://m.facebook.com/groups/TheLoopedGroup/)
7379

74-
TODO: Add link and status graphic: Crowdin Project for translation of Trio (not existing yet)
80+
## Contribute
7581

76-
# Support
77-
78-
[Trio Facebook Group](https://facebook.triodocs.org)
82+
If you would like to give something back to the Trio community, there are several ways to contribute:
7983

80-
[Loop and Learn Facebook Group](https://m.facebook.com/groups/LOOPandLEARN/)
84+
- **Help others**: assist users by answering questions and guiding them in support communities.
85+
- Improve the **documentation**: update or expand TrioDocs to help users build and use Trio.
86+
- Improve the **app**: contribute **code**, features, or fixes to the Trio iOS app.
8187

82-
[Looped Facebook Group](https://m.facebook.com/groups/TheLoopedGroup/)
88+
### Pay it forward
8389

84-
# Contribute
90+
When you have successfully built Trio and managed to get it working well for your diabetes management, it's time to pay it forward.
91+
You can start by **responding to questions** in the **Facebook or Discord** support groups, **helping others** make the best out of Trio.
8592

86-
If you would like to give something back to the Trio community, there are several ways to contribute:
93+
### Translate
8794

88-
## Pay it forward
89-
When you have successfully built Trio and managed to get it working well for your diabetes management, it's time to pay it forward.
90-
You can start by responding to questions in the Facebook or Discord support groups, helping others make the best out of Trio.
91-
92-
## Translate
93-
Trio is translated into several languages to make sure it's easy to understand and use all over the world.
94-
Translation is done using [Crowdin](https://crowdin.com/project/trio), and does not require any programming skills.
95+
Trio is translated into several languages to make sure it's easy to understand and use all over the world.
96+
Translation is done using [Crowdin](https://crowdin.triodocs.org/), and does not require any programming skills.
9597
If your preferred language is missing or you'd like to improve the translation, please sign up as a translator on [Crowdin](https://crowdin.com/project/trio).
9698

97-
## Develop
99+
### Develop
100+
98101
Do you speak JS or Swift? Do you have UI/UX skills? Do you know how to optimize API calls or improve data storage? Do you have experience with testing and release management?
99102
Trio is a collaborative project. We always welcome fellow enthusiasts who can contribute with new code, UI/UX improvements, code reviews, testing and release management.
100103
If you want to contribute to the development of Trio, please reach out on Discord or Facebook.

0 commit comments

Comments
 (0)