HoloScript

A simple, lightweight, yet effective text editor based on Python and the Tkinter library.
Currently in development, and accepting contributors (see Contributing).

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Executables
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

There are many text editors out there, but HoloScript is different from any other.
HoloScript is one of the simplest and most lightweight text editors, at around 20MB, yet it's incredibly powerful.
With no extra extensions or distractions, HoloScript focuses solely on text or code, maximizing productivity.
Built on Python and Tkinter, HoloScript is fully free and open-source.
Thanks to all contributors and Andrei Motin for creating and maintaining the project.

Hop right to Getting Started to begin your adventure with HoloScript.

(back to top)

Built With

HoloScript is based on Python, the Tkinter library and your contributions 😄

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Python 3.5 or above
• Tkinter library (tk-tools)

Installation

1. Clone the repository

   git clone https://github.com/andreimotin/HoloScript

2. Install the Tkinter library

   pip install tk-tools

3. Open the HoloScript directory

   cd HoloScript

4. Run HoloScript

   python3 holoscript.py

Executables

We are currently working hard on delivering executables (applications) to different platforms, such as macOS, Windows and Linux distributions.
When they'll be available, you'll be able to install them from Releases
Until then, you can install HoloScript using the command line (see Installation above)

(back to top)

Usage

After installing and launching HoloScript, you can immediately start writing or scripting by clicking on the work area.
The work area is the right part of the HoloScript interface that is originally blank and is apart the Open and Save As... buttons from the left button area.
The button area is the left part of the HoloScrit interface that contains the 2 main buttons: Open and Save As....

For any questions feel free to reach out to me (see Contact)

(back to top)

Roadmap

• Main script release
• Execuatable apps for macOS, Windows, Linux

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repository and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

To contribute:

1. Fork the repository
2. Clone the forked repository (git clone https://github.com/username/repo)
3. Create your branch (git branch BRANCH-NAME, git checkout BRANCH-NAME)
4. Change something you'd like
5. Add your changes to your branch (git add .)
6. Commit your Changes (git commit -m "a short description of the change")
7. Push your changes to your branch (git push)
8. Open a Pull Request

Full guide available here: Contributing Guide

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Twitter: @andreimotin12

Email: motinandrei@icloud.com

Project Link: https://github.com/andreimotin/HoloScript

(back to top)