Skip to content

Commit dc196a7

Browse files
authored
Update README.md
1 parent e2fb7db commit dc196a7

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ This is a list of known Mastodon instances on which Tangerine UI has been instal
152152
## Installation for Mastodon admins
153153

154154
### Install Tangerine UI as the only theme on your instance:
155-
1. **Check your Mastodon version**. For Tangerine UI to work properly, you need to make sure you're installing the right version for your Mastodon instance. Please check the [Compatibility](#compatibility) section in this document before you proceed.
155+
1. **Check your Mastodon version**. For Tangerine UI to work properly, you need to make sure you're installing the right version for your Mastodon instance. Please refer to the [Compatibility](#compatibility) section in this document before you proceed.
156156

157157
2. Copy & paste the contents of 🍊 [`TangerineUI.css`](https://github.com/nileane/TangerineUI-for-Mastodon/blob/main/TangerineUI.css) to the '***Custom CSS***' field in the administration panel on your Mastodon instance (Navigate to https://*domain*/admin/settings/appearance).
158158
* 🪻 For the Purple variant, copy the contents of [`TangerineUI-purple.css`](https://github.com/nileane/TangerineUI-for-Mastodon/blob/main/TangerineUI-purple.css) instead.
@@ -169,7 +169,7 @@ Your users will be able to select Tangerine UI in their settings on the web, and
169169

170170
<details>
171171
<summary><strong>Install (using the included script)</strong></summary>
172-
172+
<br>
173173

174174
A basic installation script is included in this repository.
175175
It can also be used again to update Tangerine UI on your Mastodon instance.
@@ -182,7 +182,7 @@ git clone https://github.com/nileane/TangerineUI-for-Mastodon.git ./TangerineUI
182182
cd TangerineUI
183183
```
184184

185-
2. **Copy the sample install script**.
185+
2. **Copy** the sample install script.
186186
```sh
187187
cp install.sh.sample install.sh
188188
```
@@ -191,12 +191,17 @@ Make sure the Mastodon and Tangerine UI directory paths at the top of `install.s
191191
* Edit the line beginning with `TANGERINEUI=` to adjust the path to the Tangerine UI directory.
192192
* Edit the line beginning with `MASTODON=` to adjust the path to your Mastodon installation directory.
193193

194-
4. **Run the install script**.
194+
3. **Run** the install script.
195195
```sh
196196
./install.sh
197197
```
198198

199-
5. **\[Optional\] Add a localized name.** You can edit each desired language's locale file in `config/locales/[lang].yml` to add a localized string name for Tangerine UI. You need to do this for every language you expect your users to use. Otherwise, in their themes list, they will see the unlocalized theme name ("*tangerineui-purple*"), instead of a readable theme name ("*Tangerine UI (Purple)*").
199+
Optionally, run with `--skip-confirm` to bypass all confirmation prompts:
200+
```sh
201+
./install.sh --skip-confirm
202+
```
203+
204+
4. **\[Optional\] Add a localized name.** You can edit each desired language's locale file in `config/locales/[lang].yml` to add a localized string name for Tangerine UI. You need to do this for every language you expect your users to use. Otherwise, in their themes list, they will see the unlocalized theme name ("*tangerineui-purple*"), instead of a readable theme name ("*Tangerine UI (Purple)*").
200205

201206
```yml
202207
themes:
@@ -209,7 +214,7 @@ themes:
209214
tangerineui-lagoon: Tangerine UI (Lagoon)
210215
```
211216
212-
6. **Restart** your Mastodon instance for the changes to take effect.
217+
5. **Restart** your Mastodon instance for the changes to take effect.
213218
214219
Your users should now be able to choose '*Tangerine UI*', '*Tangerine UI (Purple)*', '*Tangerine UI (Cherry)*', or '*Tangerine UI (Lagoon)*' as their site theme:
215220
@@ -223,11 +228,11 @@ As an admin, you should also now be able to set Tangerine UI as the default them
223228
224229
225230
<details>
226-
<summary><strong>Install manually (without the script)</strong></summary>
231+
<summary><strong>Install manually</strong></summary>
227232
228233
1. **Check your Mastodon version**. For Tangerine UI to work properly, you need to make sure you're installing the correct version for your Mastodon instance. Please refer to the [Compatibility](#compatibility) section in this document before you proceed.
229234
230-
2. **Copy the files** from `mastodon/app/javascript/styles/` [in this repository](https://github.com/nileane/TangerineUI-for-Mastodon/tree/main/mastodon/app/javascript/styles/) to your Mastodon themes directory `app/javascript/styles/`:
235+
2. **Copy** the files from `mastodon/app/javascript/styles/` [in this repository](https://github.com/nileane/TangerineUI-for-Mastodon/tree/main/mastodon/app/javascript/styles/) to your Mastodon themes directory `app/javascript/styles/`:
231236

232237
```sh
233238
# Where $REPO is this repository, and $INSTALLDIR is your Mastodon installation.

0 commit comments

Comments
 (0)