Git Product home page Git Product logo

quiet-text's Introduction

Quiet-Text

Quiet Text is a simple, minimalist text editor made with Python's Tkinter GUI library. Quiet Text aims to create a calming and distraction free text environment for writing code and taking notes.

there should be an image here...

Goals

  • Create a visually pleasing text editor! ;)
  • Add syntax highlighting for Python.
  • Allow user's to launch the terminal and run their scripts from any platform.
  • Add special markdown for making lists and notetaking.
  • Allow full customization of the editor's theme and colors.
  • Add helpful features for programming like autoclosing brackets and parenthesis.

suggestions are welcome!

Installation

This project requires a Python3 interpreter with Tkinter support. You can test it using

python3 -m tkinter

In case your (GNU/Linux) machine does not support tkinter, there's a way to run it inside Docker (whereas you can also use another base image than ubuntu):

FROM ubuntu
RUN apt update && apt install -y python3-tk x11-apps
RUN mkdir /code
WORKDIR /code
ADD . /code
CMD ["/usr/bin/python3", "-m", "quiet"]

Now, expose an environment variable to allow access to your host system XAUTH="$HOME/.Xauthority" and build the image using docker build -t quiet .. You can start a container using

docker run --network=host --rm -e DISPLAY=$DISPLAY -v $XAUTH:/root/.Xauthority quiet

Be aware, that the Docker container has full access to your machine! So you better trust the executed code.

Contributing Guidelines

  • Issues are open to anyone and everyone, but you must comment on the issue first and communicate to me that you are working on it. If you are confident in your ability, I will assign you to the issue.

  • Don't work on an issue that isn't assigned to you unless you communicate with the assignee first.

  • If you make an improvement on an existing feature, make sure to create an issue first and list the fixes or features you have made to the code.

  • All PRs must be made from a Branch. Create a separate branch for every Issue you are working upon and once found fit, make a PR.

  • Please make sure your code works before you submit it :)

check CONTRIBUTING.md for guidlines on how to make a pull request.

quiet-text's People

Contributors

juliuschrona avatar ryuno-ki avatar sethwalkeroo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.