Skip to content

Mohyoo/Quick-Text-Editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Palestine Children, Women and Men are dying...

Palestine Flag

About

Quick Text Editor is - you know - a handy plain text editor intended for simple use and designed to be cross platform. Not the best in its type, but still functional.

Under development. Help is highly appreciated!

Light Dark
Screenshot Light Screenshot Dark

Before Usage

Please don't put the program in a protected folder, as it's designed to be portable. Doing so will cause silent issues with reading/writing permissions.

There is a Fonts folder in the program directory, I recommend installing the JetBrains Mono and Open Sans fonts provided there. They are nice and clean, and work well for this program.

Quick Configuration

In the program directory, there will be (after the first launch) a config.json file. Its options should be clear, but just in case, here is an explanation of the necessary options:

Setting Description
text_font_priority A list of font types. If the first one is installed, the program will use it; otherwise it'll check the others in the written order (if a font doesn't work, it's either not installed, or there is a typo in its name)
ui_font_priority Same as above, but for UI elements
text_font_size Font size for the text area
ui_font_size Font size for the UI elements
indent_size How many spaces to insert when pressing TAB
max_undo How many undo steps to remember (lower = faster)
big_file_size Minimum file size (MB) to trigger a warning before opening
independent_windows If true, each instance of this editor will spawn its own process. Slightly slower at startup, but recommended if you often open big files

If false, then opening multiple small files will be faster (this is experimental; no data loss will happen, but in very exceptional cases, there might be some unexpected behavior)

To reset settings, simply delete the config.json file.

Compile From Source

You may be able bundle the program using PyInstaller or cx_Freeze, but I recommend using Nuitka to avoid issues; since the program is tuned for it, beside that it provides a small performance gain:

pip install tkinterdnd2, Nuitka
cd "where/main.py/is"
python -m nuitka --deployment --disable-cache=all --standalone --prefer-source-code --noinclude-setuptools-mode=error --plugin-enable=tk-inter --enable-plugin=anti-bloat --python-flag=-S --python-flag=-O --python-flag=no_asserts --python-flag=no_docstrings --lto=yes --remove-output --windows-console-mode=disable --windows-icon-from-ico="Assets/icon.ico" --product-name="Quick Text Editor" --file-version=0.0.0 --output-filename=quick-text-editor --include-data-files=Assets/*icon*=assets/ --include-data-dir=Fonts=fonts --include-data-files=LICENSE.txt=LICENSE.txt --include-data-files=release-readme.txt=README.txt main.py

Don't forget to change the version (--file-version=0.0.0).

If you have a Static Python distribution, add this argument --static-libpython=yes to create a standalone release that doesn't rely on system shared libraries.

When the program is compiled with Nuitka, it'll automatically write console output to a log file in its dir. But since Nuitka removes comments and doc-strings from source code (--python-flag=no_docstrings), you should rely on function names more than line numbers when using that log file to debug.

Thank You

If you are reading this, then thank you for your time...
If you find this program useful and satisfying, drop a 🌟!

About

A handy text editor for quick use.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages