|
1 |
| -# CE C Toolchain |
2 |
| -Toolchain for C programming on the 'CE' series of TI calculators (TI-84 Plus CE / TI-83 Premium CE) |
| 1 | +# About |
3 | 2 |
|
4 |
| -# Installation |
5 |
| -1. Download and extract the .zip file from [the latest release](https://github.com/CE-Programming/toolchain/releases/latest) ; you should see a folder inside called 'CEdev' |
6 |
| -**Note:** Place the CEdev folder somewhere close to your root directory, i.e. `C:\CEdev` (or `~/CEdev` on macOS/Linux), with **no spaces** in the path for best results. |
7 |
| -2. Add a user environment variable called `CEDEV`, pointing to the CEdev folder _(instructions on how to do that on: [Windows](http://www.computerhope.com/issues/ch000549.htm), [Mac](http://stackoverflow.com/a/7502061/378298), [Linux](http://unix.stackexchange.com/a/117470))_ |
8 |
| -3. Edit the system environment variable called `PATH` to append the `bin` folder in the CEdev folder (`CEdev/bin`) _(instructions on how to do that on: [Windows](http://www.computerhope.com/issues/ch000549.htm), [Mac](http://stackoverflow.com/a/7502061/378298), [Linux](http://unix.stackexchange.com/a/117470))_ |
9 |
| -4. If you are running under Linux or macOS, [wine](https://www.winehq.org/) is required to build. Usually using the absolute path to make.exe in the CEdev/bin directory works the best, i.e. `wine ~/CEdev/make.exe` |
| 3 | +The CE C Software Development Kit incorporates a wide variety of tools and documentation in order to build programs in C natively for the TI-84+CE/TI-83PCE line of calculators. |
10 | 4 |
|
11 |
| -Included you will find the ['Standard' CE C Libraries](https://github.com/CE-Programming/libraries/releases/latest). These perform efficient and easy support for graphics, file I/O, keypad input, etc. You can find examples in [`CEdev/examples/library_examples`](CEdev/examples/library_examples) |
| 5 | +# Getting Started |
12 | 6 |
|
13 |
| -For more information on how to use this toolchain, please see the documentation page: https://ce-programming.github.io/documentation/ |
14 |
| -You can also join us on IRC on the EFNet servers: #ez80-dev (and #cemu-dev for CEmu) |
| 7 | +It is recommended that you grab the latest release from [here](https://github.com/CE-Programming/toolchain/releases/latest) if you are looking to get started. Feel free to also bookmark the [wiki pages](https://github.com/CE-Programming/toolchain/wiki), as they will become a helpful guide. |
| 8 | + |
| 9 | +Included you will find examples using the ['Standard' CE C Libraries](https://github.com/CE-Programming/libraries/releases/latest). These perform efficient and easy support for graphics, file I/O, keypad input, etc. Be sure to grab them if you plan to use them. |
| 10 | + |
| 11 | +## Building |
| 12 | + |
| 13 | +These steps are only if you wish to help with development of the toolchain. |
| 14 | + |
| 15 | +If you are using windows, [mingw+msys](http://www.mingw.org) is required for building. |
| 16 | +If you are using linux or mac, [wine](https://www.winehq.org) is required for building. |
| 17 | + |
| 18 | +Clone the repo: (Note the --recursive option) |
| 19 | +`git clone --recursive https://github.com/CE-Programming/toolchain.git` |
| 20 | + |
| 21 | +Then type: |
| 22 | +`cd toolchain && make && make install` |
| 23 | + |
| 24 | +By default, `make install` will install into the home (~) directory on linux and mac, and in the root (C:\) drive on windows. This is configurable with `make install PREFIX={NEWDIR}` |
| 25 | + |
| 26 | +If you wish to view a list of available makefile rules, type: `make help` |
| 27 | + |
| 28 | +If you wish to build a release; [nsis](https://sourceforge.net/projects/nsis/) is required for windows. Because of limitations of the current software; the special *Large strings* build is needed. You can find it [here](http://nsis.sourceforge.net/Special_Builds). Note also that you must configure your path variable to point to the nsis installation directory. |
| 29 | + |
| 30 | +To build a release, type: `make dist` |
| 31 | + |
| 32 | +## Help |
| 33 | + |
| 34 | +You can join us on the IRC/EFNet server `#ez80-dev` if you have any questions: [ask for help](http://chat.efnet.org:9090/?nick=sdk-user&channels=%23ez80-dev&Login=Login) |
0 commit comments