summaryrefslogtreecommitdiff
path: root/content/monogatari.md
diff options
context:
space:
mode:
Diffstat (limited to 'content/monogatari.md')
-rw-r--r--content/monogatari.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/content/monogatari.md b/content/monogatari.md
new file mode 100644
index 0000000..672163c
--- /dev/null
+++ b/content/monogatari.md
@@ -0,0 +1,62 @@
++++
+title = 'Monogatari'
+date = 2024-08-17T07:44:33+01:00
+tags = ['projects', 'programming', 'python', 'linux', 'windows']
++++
+
+# [MONOGATARI - Text Editor](https://github.com/henrique-marques-vsoft/monogatari)
+
+![monogatari-movie scene shinobu kokorowatari](https://raw.githubusercontent.com/henrique-marques-vsoft/monogatari/master/pics/shinobu.gif)
+
+Monogatari is a text editor built with Python using the Tkinter GUI library.
+
+## Installation and usage
+
+Assuming you already have Python installed in your machine:
+
+```
+git clone [email protected]:all123all/monogatari.git
+cd monogatari
+python monogatari.py
+```
+
+If you're using Linux you probably will need to install tk manually:
+
+```
+//Arch based distros
+$ sudo pacman -S tk
+//For Ubuntu
+$ sudo apt-get install tk
+```
+
+## Goals
+
+- [ ] Basic text editor functionalities (create file, open file, exit etc.)
+- [ ] Black background and a colorpicker option to choose another color
+- [ ] Test routine for the basic functionalities
+- [ ] Release a package
+- [ ] The close function is being called even when the file isn't modified
+
+## Contribute to MONOGATARI - Text Editor
+
+- Click the fork button on top right
+- Git clone your fork
+- Connect with my repo:
+
+```
+$ git remote add all123all git://github.com/all123all/monogatari
+$ git remote -v
+```
+
+You are now ready to start to code! Just do as always:
+
+```
+$ git add .
+$ git commit -m "fix: something that was fixed"
+$ git push
+```
+
+Then you can create a pull request right here on Github. Just go to the Pull Requests tab and select `New pull request` button to do so.
+
+## Screenshots
+![monogatari on i3wm screenshot](https://raw.githubusercontent.com/henrique-marques-vsoft/monogatari/master/pics/print.png)