Skip to content

Commit 3e01e42

Browse files
authored
Improve README
1 parent a46b04e commit 3e01e42

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ tiny_tds is tested with Ruby v2.7 and upwards.
2222

2323
### Windows and Linux (64-bit)
2424

25-
We precompile tiny_tds with static versions of FreeTDS and supporting libraries. Just run:
25+
We precompile tiny_tds with FreeTDS and supporting libraries, which are dynamically linked at runtime. Therefore, you can run:
2626

2727
```shell
2828
gem install tiny_tds
2929
```
3030

3131
It should find the platform-specific gem.
3232

33-
You can also avoid getting the platform-specific gem if you want to compile FreeTDS yourself:
33+
You can also avoid getting the platform-specific gem if you want to compile FreeTDS and supporting libraries yourself:
3434

3535
```shell
3636
gem install tiny_tds --platform ruby
@@ -41,6 +41,7 @@ gem install tiny_tds --platform ruby
4141
Install FreeTDS via Homebrew:
4242

4343
```shell
44+
brew install openssl@3 libiconv
4445
brew install freetds
4546
```
4647

@@ -52,7 +53,7 @@ gem install tiny_tds
5253

5354
### Everybody else
5455

55-
`tiny_tds` will find FreeTDS based on your compiler paths. Below you can see an example on how to install FreeTDS on a Debian system.
56+
`tiny_tds` will find FreeTDS and other libraries based on your compiler paths. Below you can see an example on how to install FreeTDS on a Debian system.
5657

5758
```shell
5859
$ apt-get install wget
@@ -440,6 +441,9 @@ $ rake TINYTDS_UNIT_HOST=mydb.host.net TINYTDS_SCHEMA=sqlserver_azure
440441

441442
### Compiling Gems for Windows and Linux
442443

444+
> [!WARNING]
445+
> Compiling the Gems on native Windows currently does not work.
446+
443447
For the convenience, TinyTDS ships pre-compiled gems for supported versions of Ruby on Windows and Linux. In order to generate these gems, [rake-compiler-dock](https://github.com/rake-compiler/rake-compiler-dock) is used.
444448

445449
Run the following rake task to compile the gems. This will check the availability of [Docker](https://www.docker.com/) and will give some advice for download and installation. When docker is running, it will download the docker image (once-only) and start the build:

0 commit comments

Comments
 (0)