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

Better readme #7

Merged
merged 2 commits into from
Nov 26, 2017
Merged

Better readme #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f332eb5
Trying to create a better README.
dkfellows Nov 26, 2017
c857109
Trying to make the table work
dkfellows Nov 26, 2017
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
86 changes: 24 additions & 62 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,68 +21,30 @@ CONTENTS
The following is a short description of the files you will find in
the sample extension.

Makefile.in Makefile template. The configure script uses this file to
produce the final Makefile.

license.terms License info for this package.

aclocal.m4 Generated file. Do not edit. Autoconf uses this as input
when generating the final configure script. See "tcl.m4"
below.

configure Generated file. Do not edit. This must be regenerated
any time configure.in or tclconfig/tcl.m4 changes.

configure.in Configure script template. Autoconf uses this file as input
to produce the final configure script.

pkgIndex.tcl.in Package index template. The configure script will use
this file as input to create pkgIndex.tcl.

llvmtcl-gen.inp Input for llvmtcl-gen.tcl. It contains reformatted function
declarations of the LLVM C API.

llvmtcl-gen.tcl Script to generate the Tcl API to the LLVM C API. The
llvmtcl-gen.inp is the input for this script.

generic/ This directory contains various source files, some only
generated during compilation (i.e., after `make`).

llvmtcl.cpp File containing most non-generated parts of the Tcl API to
the LLVM C API. Also includes some sections which can only
be implemented using the LLVM C++ API.

llvmtcl.h File containing all the internal APIs of llvmtcl.

attributes.cpp
File containing the Tcl API to the LLVM attribute
management code.

debuginfo.cpp
File containing the Tcl API to the LLVM debugging
information generation code.

powidf2.cpp File containing the implementation of one of the LLVM
intrinsics, needed on some platforms and with some linkers.

testcode.cpp Code only used for testing purposes.

version.h Simplifies LLVM API version detection.

llvmtcl.tcl Scripts using the Tcl API to the LLVM C API.

tests/ Some tests for the package.

tclconfig/ This directory contains various template files that build
the configure script. They should not need modification.

install-sh Program used for copying binaries and script files
to their install locations.

tcl.m4 Collection of Tcl autoconf macros. Included by
aclocal.m4 to define SC_* macros.

win/ Files used for building on Windows.
| Name | Purpose |
| ---- | ------- |
| `Makefile.in` | Makefile template. The `configure` script uses this file to produce the final `Makefile`. |
| `license.terms` | License info for this package. |
| `aclocal.m4` | Generated file. Do not edit. Autoconf uses this as input when generating the final configure script. See `tcl.m4` below. |
| `configure` | Generated file. Do not edit. This must be regenerated any time `configure.in` or `tclconfig/tcl.m4` changes. |
| `configure.in` | Configure script template. Autoconf uses this file as input to produce the final `configure` script. |
| `pkgIndex.tcl.in` | Package index template. The `configure` script will use this file as input to create `pkgIndex.tcl`.
| `llvmtcl-gen.inp` | Input for `llvmtcl-gen.tcl`. It contains reformatted function declarations of the LLVM C API. |
| `llvmtcl-gen.tcl` | Script to generate the Tcl API to the LLVM C API. The `llvmtcl-gen.inp` is the input for this script. |
| `generic/` | This directory contains various source files, some only generated during compilation (i.e., after `make`). |
| `generic/llvmtcl.cpp` | File containing most non-generated parts of the Tcl API to the LLVM C API. Also includes some sections which can only be implemented using the LLVM C++ API. |
| `generic/llvmtcl.h` | File containing all the internal APIs of llvmtcl. |
| `generic/attributes.cpp` | File containing the Tcl API to the LLVM attribute management code. |
| `generic/debuginfo.cpp` | File containing the Tcl API to the LLVM debugging information generation code. |
| `generic/powidf2.cpp` | File containing the implementation of one of the LLVM intrinsics, needed on some platforms and with some linkers. |
| `generic/testcode.cpp` | Code only used for testing purposes. |
| `generic/version.h` | Simplifies LLVM API version detection. |
| `llvmtcl.tcl` | Scripts using the Tcl API to the LLVM C API. |
| `tests/` | Some tests for the package. |
| `tclconfig/` | This directory contains various template files that build the `configure` script. They should not need modification. |
| `tclconfig/install-sh` | Program used for copying binaries and script files to their install locations. |
| `tclconfig/tcl.m4` | Collection of Tcl autoconf macros. Included by `aclocal.m4` to define `SC_*` macros. |
| `win/` | Files used for building on Windows. |

UNIX BUILD (including OSX)
==========================
Expand Down