2018-05-06 19:49:22 +03:00
< p align = "center" > < img src = "https://raw.githubusercontent.com/felixangell/phi/gh-pages/images/icon96.png" > < / p >
2016-12-02 20:08:42 +03:00
2018-04-22 20:43:01 +03:00
< h1 > phi< / h1 >
2018-06-23 01:48:58 +03:00
2018-04-29 21:12:49 +03:00
Phi is a minimal code editor designed to look pretty, run fast, and be easy
2018-04-17 03:54:12 +03:00
to configure and use. It's primary function is for editing code.
2018-04-14 04:17:13 +03:00
2018-05-18 15:59:05 +03:00
The editor is still a work in progress. There is a chance it will **eat up your battery** , **run quite slowly** ,
2018-05-18 15:58:14 +03:00
and probably **crash frequently** .
2018-04-14 04:17:13 +03:00
2018-05-18 16:12:43 +03:00
< p align = "center" > **Do not edit your precious files with this editor!**< / p >
2016-12-02 20:06:11 +03:00
2018-04-22 20:43:01 +03:00
Here's a screenshot of Phi in action:
2017-11-04 17:24:44 +03:00
2019-05-17 02:05:31 +03:00
< p align = "center" > < img src = "https://raw.githubusercontent.com/felixangell/phi/gh-pages/images/screenshot.png" > < / p >
2017-11-04 17:24:44 +03:00
2016-11-26 23:45:39 +03:00
# goals
The editor must:
2018-02-28 16:23:07 +03:00
* run fast;
2016-11-26 23:45:39 +03:00
* load and edit large files with ease;
* look pretty; and finally
2018-04-17 03:54:12 +03:00
* be easy to use
2016-11-26 23:45:39 +03:00
2018-04-29 21:12:49 +03:00
## non-goals
The editor probably wont:
* have any plugin support;
* be very customizable in terms of layout;
* support many non utf8 encodings;
* support non true-type-fonts;
* support right-to-left languages;
2019-06-01 02:21:13 +03:00
Avoiding most of these is to avoid complexity in the code-base
and general architecture of the editor and is beyond the scope of this project currently.
2018-04-29 21:12:49 +03:00
2018-04-22 20:43:01 +03:00
# why?
2019-06-01 02:21:13 +03:00
The editor does not exist as a serious replacement to Sublime Text/VSCode/Emacs/[editor name here].
2018-04-22 20:43:01 +03:00
Though one of my big goals for the project is to possibly replace sublime text for my own personal use. Thus the editor is somewhat optimized for my own work-flow.
The code is up purely for people to look at and maybe use or contribute or whatever. Sharing is caring!
2018-04-17 16:23:51 +03:00
# reporting bugs/troubleshooting
Note the editor is still unstable. Please report any bugs you find so I can
2019-06-01 02:21:13 +03:00
squash them! It is appreciated if you skim the issue (or search!) handler to make sure
2018-04-17 16:23:51 +03:00
you aren't reporting duplicate bugs.
## before filing an issue
Just to make sure it's an issue with the editor currently and not due to a
2019-06-01 02:21:13 +03:00
broken change - please can you:
2018-04-17 16:23:51 +03:00
* make sure the repository is up to date
* make sure all the dependencies are updated, especially "github.com/felixangell/strife"
* try removing the ~/.phi-config folder manually and letting the editor re-load it
2016-11-16 07:26:29 +03:00
# building
2019-06-01 02:21:13 +03:00
See the [BUILDING ](/BUILDING.md ) file.
2016-11-16 07:26:29 +03:00
2016-11-14 10:06:25 +03:00
# license
2016-11-27 20:31:40 +03:00
[MIT License ](/LICENSE )