Skip to content

Commit c6ecdf8

Browse files
committed
update paths for theos rc makefile
1 parent 7bad973 commit c6ecdf8

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

docs/Configuration.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,14 @@ Theos, and your project(s), can be configured in a few differents ways:
88
- At runtime via project Makefiles
99
- At runtime by passing variables to `make`
1010

11-
## `.theosrc`
11+
## Config File
1212

13-
Variables that are specific to your own setup (e.g., Xcode/an SDK, device IP, etc) should not be placed in your project makefile as it may hinder others from building your project. Instead, these variables should be placed in `.theosrc`, a makefile that is read and executed during an early stage of Theos’ `common.mk`.
13+
Variables that are specific to your own setup (e.g., Xcode/an SDK, device IP, etc) should not be placed in your project makefile as it may hinder others from building your project. Instead, these variables should be placed in a user created makefile that is read and executed during an early stage of Theos’ `common.mk`.
1414

15-
`.theosrc` must be created by the user at `$HOME/.theosrc` or `~/.theosrc`.
15+
The first matching file is `-include`d:
16+
1. `$(XDG_CONFIG_HOME)/theos/rc.mk`
17+
2. `$(HOME)/.config/theos/rc.mk`
18+
3. `$(HOME)/.theosrc`
1619

1720
## Utilizing Theos' makefile rules
1821

docs/Parallel-Building.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,5 @@ These instructions assume you use Homebrew and have installed Theos as outlined
3838
If you’d rather not perform these steps, you can permanently ignore this notice by using the following:
3939

4040
```bash
41-
echo 'THEOS_IGNORE_PARALLEL_BUILDING_NOTICE = yes' >> ~/.theosrc
41+
echo 'THEOS_IGNORE_PARALLEL_BUILDING_NOTICE = yes' >> ~/.config/rc.mk
4242
```

docs/Upgrading-from-legacy-Theos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Changes made since [legacy Theos](https://github.com/theos/theos/tree/legacy) ma
2727

2828
* **Theos heavily relies on Git.** Always install Theos [as directed](/docs/Installation.html); do not download it as a ZIP.
2929
* **The `theos` symlink is no longer created by NIC in new projects.** The destination of this symlink can vary between computers, as Theos does not impose requirements on where it must be stored. The symlink is also often committed to source control (i.e., Git) unintentionally. As it was already highly recommended to set the `$THEOS` variable in your environment, we have opted to switch new makefiles to use `$THEOS` instead of the symlink. Changing this in your existing projects is recommended. Refer to [this FAQ entry](/docs/FAQ.html#wheres-the-theos-symlink).
30-
* **Configuration related to your environment, rather than the project, should be in `~/.theosrc`.** If you set variables that are specific to your own setup, such as the location of Xcode/an SDK, device IP, etc., you should avoid placing it in your project makefile, as these types of things can vary between users. Move these to `~/.theosrc`, a makefile that is read and executed during an early stage of Theos’ `common.mk`.
30+
* **Configuration related to your environment, rather than the project, should be in `~/.config/theos/rc.mk`.** If you set variables that are specific to your own setup, such as the location of Xcode/an SDK, device IP, etc., you should avoid placing it in your project makefile, as these types of things can vary between users. Move these to `~/.config/theos/rc.mk`, a makefile that is read and executed during an early stage of Theos’ `common.mk`.
3131
* **Built packages have been moved to a directory called `packages`.** The intent here is to reduce clutter in the root project directory and separate build output from the project source.
3232
* **The `obj` directory has been moved to inside `.theos`.** Again, this is for cleanliness. You may need to enable displaying of hidden files in your operating system/file manager to see this directory.
3333
* **The linker flag required for tweaks to run in 32-bit processes on 64-bit devices running iOS 9 is not necessary.** Theos already applies it for you.

0 commit comments

Comments
 (0)