📦➔🦋 Store and retrieve files on the Atmosphere
README: improve installation instructions
+8
-10
+8
-10
README.md
+8
-10
README.md
···
25
25
* **OS¹**
26
26
* 🟡 **Linux**: GNU, MinGW and Termux only; musl² not supported
27
27
* 🟢 **macOS**: Compatible with built-in version of Bash (3.2)
28
-
* 🟡 **Windows**: MinGW (Cygwin, Git Bash, MSYS2, etc.) and WSL (see Linux caveats above)
29
-
* This repository **does not** provide a native version for Windows
28
+
* 🔴 **Windows**: No native version available
29
+
* Run with MinGW (Cygwin, Git Bash, MSYS2, etc.) or WSL (See Linux caveats above)
30
30
* 🟢 __*BSD__: FreeBSD, NetBSD, OpenBSD, and other *BSD's
31
31
* 🟢 **Haiku**: [Yes, really](https://bsky.app/profile/did:plc:kv7sv4lynbv5s6gdhn5r5vcw/post/3lboqznyqgs26)
32
32
* 🔴 **Solaris**: <span title="Don't we all?">Has issues</span>; low priority
···
64
64
65
65
This will automatically fetch the latest version of ATFile and install it in an appropriate location, as well as creating a blank configuration file. Once downloaded and installed, the locations used will be output. They are as follows:
66
66
67
-
* __Linux/Windows/*BSD/Solaris/SerenityOS__
67
+
* __Linux/*BSD/Solaris/SerenityOS__
68
68
* Install: `$HOME/.local/bin/atfile`
69
69
* As `sudo`/`root`: `/usr/local/bin/atfile`
70
-
* Config: `$HOME/.config/atfile.env`
70
+
* Config: `$HOME/.config/atfile.env`, **or** `$XDG_CONFIG_HOME/atfile.env` (if set)
71
71
* **macOS**
72
72
* Install: `$HOME/.local/bin/atfile`
73
73
* As `sudo`/`root`: `/usr/local/bin/atfile`
···
77
77
* Config: `$HOME/config/settings/atfile.env`
78
78
* `$HOME` is **always** `/home` on Haiku
79
79
80
-
If `$XDG_CONFIG_HOME` is set, this will overwrite the config directory (e.g. setting `XDG_CONFIG_HOME=$HOME/.local/share/atfile` will result in the config being stored at `$HOME/.local/share/atfile/atfile.env`). Custom config paths are supported, but set after-the-fact — see **Manually** below.
81
-
82
80
#### Manually
83
81
84
-
To install manually, see [tags on @zio.sh/atfile](https://tangled.sh/@zio.sh/atfile/tags), and download the required version under **Artifacts**. This can be stored and run from anywhere (and is identical to the version `curl|bash` fetched — this installed version can also be moved to custom locations at whim).
82
+
See [tags on @zio.sh/atfile](https://tangled.org/@zio.sh/atfile/tags), and download the required version under **Artifacts** — this can be stored and run from anywhere (and is identical to the version `curl|bash` fetched. Consider renaming to `atfile.sh` (as ATFile can update itself, making a fixed version in the filename nonsensical), and mark as executable (with `chmod +x atfile.sh`).
85
83
86
-
Don't forget to mark as executable with `chmod +x atfile.sh`. It's also a good idea to remove the version from the filename, as ATFile can update itself (with `atfile update`) and will overwrite the file (this functionality can be disabled with `ATFILE_DISABLE_UPDATE_COMMAND=1`).
87
-
88
-
Config locations are identical to those above (see **Automatic ("`curl|bash`")** above). To use a custom path, set `$ATFILE_PATH_CONF`. Variables can also be used (and overridden) with exports — see **`atfile help` ➔ Environment Variables** for more.
84
+
Config locations are identical to those above (see **Automatic ("`curl|bash`")** above).
89
85
90
86
#### Repository
91
87
92
88
If you've pulled this repository, you can also use ATFile by simply calling `./atfile.sh` — it functions just as a regular compiled version of ATFile, including reading from the same config file. Debug messages are turned on by default: disable these by setting `ATFILE_DEBUG=0`.
89
+
90
+
Config locations are identical to those above (see **Automatic ("`curl|bash`")** above).
93
91
94
92
**Using a development version against your ATProto account could potentially inadvertently damage records.**
95
93