Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: Link to other docs #13

Merged
merged 1 commit into from
Dec 25, 2017
Merged

README: Link to other docs #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,49 @@ Or install it yourself as:

$ gem install tk

## Documentation

### Read this first

If you want to use Ruby/Tk (tk.rb and so on), you must have tcltklib.so
which is working correctly. When you have some troubles on compiling,
please read [README.tcltklib] and [README.ActiveTcl].

Even if there is a tcltklib.so on your Ruby library directory, it will not
work without Tcl/Tk libraries (e.g. libtcl8.4.so) on your environment.
You must also check that your Tcl/Tk is installed properly.

--------------------------------------------

Ruby/Tk (tk.rb など) を使いたい場合には，tcltklib.so が正しく動いていな
ければなりません．コンパイル時に何か問題が生じた場合は，[README.tcltklib]
や [README.ActiveTcl] を見てください．

たとえ Ruby のライブラリディレクトリに tcltklib.so が存在していたとして
も，実行環境に Tcl/Tk ライブラリ (libtcl8.4.so など) がなければ機能しま
せん．Tcl/Tk が正しくインストールされているかもチェックしてください．

<tt>==========================================================
Hidetoshi NAGAI (nagai@ai.kyutech.ac.jp)</tt>

### Manual

- [Manual tcltklib, in English](MANUAL_tcltklib.eng)
- [Manual tcltklib, in Japanese](MANUAL_tcltklib.ja)

### Other documents

[README.tcltklib] for compilation instructions.

[README.fork] is a note on forking.

[README.macosx-aqua] is about MacOS X Aqua usage.

[README.tcltklib]: README.tcltklib
[README.ActiveTcl]: README.ActiveTcl
[README.fork]: README.fork
[README.macosx-aqua]: README.macosx-aqua

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand Down