Skip to content

Commit dd5e47f

Browse files
committed
docs: describe what the shell variables are for
I've had feedback that the variables are confusing as you may be expecting to replace them if you've seen other install guides/etc. in the past. Let's be clear about what they are to avoid confusion
1 parent b1fd96d commit dd5e47f

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,21 @@ generated by this command is usable wherevere the language server is supported!
5252

5353
# Copy/pasteable commands
5454

55+
> [!NOTE]
56+
> In the following instructions we use some variables (`$AUTOGEN_FLAGS`,
57+
> `$CONFIGURE_FLAGS`, etc.). These **don't need to be replaced by you**.
58+
> Instead, the shell you are in will have them automatically populated.
59+
>
60+
> Some of the flags are important, for example they might have paths
61+
> to dependencies, so you should keep them intact. For adding your own
62+
> customizations you can add additional flags to the command line. For example,
63+
> to set an external tarball directory you could run this in place of the
64+
> existing `./autogen.sh` line:
65+
>
66+
> ```
67+
> ./autogen.sh $AUTOGEN_FLAGS --with-external-tar=../../core-tarballs
68+
> ```
69+
5570
Before you get started, you'll need to clone this repository to your system. We
5671
recommend that you keep it alongside your LibreOffice and Collabora Online code
5772
rather than putting one inside the other

0 commit comments

Comments
 (0)