Skip to content

Commit 61822ad

Browse files
committed
Update x2.3r1 README
1 parent 24b1c58 commit 61822ad

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# x2
22

3-
## Welcome
3+
## Introduction
44

5-
Welcome to the official documentation of x2! This documentation will get you started in the development of your first x2 project or will help you learn more about x2 in general with in-depth explanations and tutorials.
5+
Welcome to the official documentation for x2! This documentation will get you started in the development of your first x2 project or will help you learn more about x2 in general with in-depth explanations and tutorials.
6+
7+
If you're looking for a faster alternative to x2, check out [Calcium](https://github.com/Dm12332131mD/calcium). It's based around the same principles as x2, but written in C++ and fully OOP-compliant.
68

79
## Table of Contents
810

911
- **Home ▾**
10-
- [Welcome](#welcome)
11-
- [Table of Contents](#table-of-contents)
12+
- [Introduction](#introduction)
13+
- [ToC](#table-of-contents)
1214
- [About](#about)
1315
- [Getting Started ▾](#getting-started)
1416
- [Step 1: Installation](#step-1-installation)
@@ -23,19 +25,20 @@ Welcome to the official documentation of x2! This documentation will get you sta
2325
- [Python API](./md/pythonAPI.md)
2426
- [Standard Library](./md/standardLibrary.md)
2527

28+
***Please note: current x2 documentation is likely invalid due to the release of x2.3r1!**
29+
2630
## About
2731

28-
x2 (Pronounced "ex-two") is a high-level, interpreted language written in Python by [iiPython](https://github.com/ii-Python/) with low-level programming language syntax, such as [x86 Assembly](https://en.wikipedia.org/wiki/X86_assembly_language) or [Batch](https://en.wikipedia.org/wiki/Batch_file).
32+
x2 (Pronounced "ex-two") is a high-level, interpreted language written in Python by [iiPython](https://github.com/ii-Python/) with low-level programming language syntax, similar to that of [x86 Assembly](https://en.wikipedia.org/wiki/X86_assembly_language) or [Batch](https://en.wikipedia.org/wiki/Batch_file).
2933

3034
x2 contains features such as:
3135
- Automatic Garbage Collection
32-
- Scoped/Global Variables
33-
- Public/Private Sections
34-
- Functions and Methods
36+
- Scoped/global Variables
37+
- Sectioning/function system
3538
- Python Integration
36-
- Working Import/Export System
37-
- Package System
38-
- ...And more!
39+
- Import/Export System
40+
- Package Management System ([xpm](https://github.com/ii-Python/xpm); coming soon!)
41+
- ... many more!
3942

4043
## Getting Started
4144

@@ -59,21 +62,20 @@ If you are choosing Visual Studio Code as your Integrated Development Environmen
5962

6063
### Step 2: Set-Up
6164

62-
Once you open up your x2 project, you should be able to find a file named `main.xt`. By default, this is your main entry file and is where you will be writing your x2 code. Within the file, you should see:
65+
Once you open up your x2 project, you should be able to find a file named `main.x2`. By default, this is your main entry file and is where you will be writing your x2 code. Within the file, you should see an example program similar to:
6366

6467
```xt
6568
:: Main
66-
:main
67-
out "Hello, world!"
69+
prt "Hello, world!"
6870
```
6971

70-
Any x2 files should always end in the `.xt` extension. The main entry file should also always contain a `:main` section.
72+
Any x2 files should always end in the `.x2` extension.
7173

72-
You can edit the main entry file by editing the configuration in `.xtconfig`. It is a JSON-like file that contains all the configurations for your x2 project. Within it, you should see:
74+
You can edit the main entry file by editing the configuration in `.x2config`. It is a JSON-like file that contains all the configurations for your x2 project. Within it, you should see:
7375

7476
```xtconfig
7577
{
76-
"main": "main.xt"
78+
"main": "main.x2"
7779
}
7880
```
7981

@@ -112,7 +114,7 @@ You can publish your games and packages at [our website](https://x2.iipython.cf/
112114
### Contributors
113115

114116
- [iiPython](https://github.com/ii-Python/) - Lead Developer
115-
- [Dm123321_31mD](https://github.com/Dm12332131mD) - Contributor
117+
- [Dm123321_31mD](https://github.com/Dm12332131mD) - Developer + moral support
116118

117119
### Resouces
118120

@@ -122,6 +124,6 @@ You can publish your games and packages at [our website](https://x2.iipython.cf/
122124

123125
---
124126

125-
Last Updated: February 6th, 2022 by Dm123321_31mD
127+
Last Updated: April 22nd, 2022 by iiPython
126128

127129
[↑ Go To Top](#x2)

0 commit comments

Comments
 (0)