aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBobby <[email protected]>2022-11-05 11:39:31 -0400
committerBobby <[email protected]>2022-11-05 11:39:31 -0400
commita394ee24e629872e1e2bc69837e2ca2374324514 (patch)
tree1b6e106f1489b4d0c78118cc6149ac823f9ec287 /README.md
parentc3ee9219036c37b41885d1686f1cefce1983ca4a (diff)
downloadtexty-a394ee24e629872e1e2bc69837e2ca2374324514.tar.xz
texty-a394ee24e629872e1e2bc69837e2ca2374324514.zip
docs: update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md
index a46492f..7823aab 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,13 @@
# Texty
Text Editor
+## Requirements
+
+Before you start using, building or contributing, there are a few things you need to have installed and configured on your machine:
+
+- [Git](https://git-scm.com/downloads)
+- [Python 3.6+](https://www.python.org/downloads/)
+
## Quick Start
To get started immediately, you can run the `setup.py` script. This is a Python script that is used to do a lot of things. It can be thought of as a manager script for this project. It is used to install requirements, run the project, and more. To run the script, type the following command in your terminal:
@@ -41,13 +48,6 @@ The project is open to contributions. All kinds of suggestions are welcome. I wa
GitHub is being exclusively used to host code, to track issues and feature requests, as well as accept pull requests for this project. Following is a guideline for developing via GitHub:
-### Requirements
-
-Before you start contributing, there are a few things you need to have installed and configured on your machine:
-
-- [Git](https://git-scm.com/downloads)
-- [Python 3.6+](https://www.python.org/downloads/)
-
### Making Changes
> You can skip this step if you ran the `setup.py` script successfully.