Tyro/README.md

# Tyro

A Cross-platform Code Editor

## Planned Features

* Syntax Highlighting
* Line Numbers
* Custom Syntax themes
* SFTP editing

## Building

### Linux (Ubuntu/Debian)
Required packages:

* build-essential
* cmake
* libssh2-1-dev
* libwxgtk3.0-dev

After these packages are installed, the project should build with a simple `make` command.

### OS X
Install wxWidgets library (Using homebrew):
* `brew install wxmac`

Install libssh2 (Using homebrew):

* `brew install libssh2`

Build the app:

* `make Tyro.app`

### Windows

See the guide for building on Windows: [Windows-Build](./Windows-Build.md)

## Make commands
Please note that make commands are chainable. For a typical programming loop, `make clean dev run` is very useful.

* all - Make a release binary in the build folder
* clean - Remove intermediate build files
* dev - Make a development binary in the build folder
* run - Run the current binary in the build folder
* release - Make a release binary, with the appropriate resources compiled in. Makes an app bundle on OS X, and adds the icon to the program on Windows.
Update README.md 2017-01-25 12:03:03 -05:00			`# Tyro`
Add README and Edit menu 2015-03-30 16:38:52 -04:00
			`A Cross-platform Code Editor`

Change to outline icons and update readme 2015-04-15 14:19:28 -04:00			`## Planned Features`
Add README and Edit menu 2015-03-30 16:38:52 -04:00
			`* Syntax Highlighting`
			`* Line Numbers`
			`* Custom Syntax themes`
			`* SFTP editing`

Change to outline icons and update readme 2015-04-15 14:19:28 -04:00			`## Building`
Icons and a basic toolbar 2015-04-02 14:20:35 -04:00
Change to outline icons and update readme 2015-04-15 14:19:28 -04:00			`### Linux (Ubuntu/Debian)`
			`Required packages:`

			`* build-essential`
Fix some bugs, add a proper license 2019-06-03 11:14:38 -04:00			`* cmake`
Change to outline icons and update readme 2015-04-15 14:19:28 -04:00			`* libssh2-1-dev`
Progress commit 2015-11-03 13:30:00 -05:00			`* libwxgtk3.0-dev`
Change to outline icons and update readme 2015-04-15 14:19:28 -04:00
			After these packages are installed, the project should build with a simple `make` command.

			`### OS X`
Fix some bugs, add a proper license 2019-06-03 11:14:38 -04:00			`Install wxWidgets library (Using homebrew):`
			* `brew install wxmac`
Change to outline icons and update readme 2015-04-15 14:19:28 -04:00
			`Install libssh2 (Using homebrew):`

			* `brew install libssh2`

			`Build the app:`

			* `make Tyro.app`

			`### Windows`
Icons and a basic toolbar 2015-04-02 14:20:35 -04:00
Update readme and start on Windows build instructions 2015-04-24 16:50:46 -04:00			`See the guide for building on Windows: [Windows-Build](./Windows-Build.md)`

Add menu images for Windows, update Windows readme 2015-04-28 16:14:04 -04:00			`## Make commands`
			Please note that make commands are chainable. For a typical programming loop, `make clean dev run` is very useful.

			`* all - Make a release binary in the build folder`
			`* clean - Remove intermediate build files`
			`* dev - Make a development binary in the build folder`
			`* run - Run the current binary in the build folder`
			`* release - Make a release binary, with the appropriate resources compiled in. Makes an app bundle on OS X, and adds the icon to the program on Windows.`

Update readme and start on Windows build instructions 2015-04-24 16:50:46 -04:00

Progress commit 2015-11-03 13:30:00 -05:00