Skip to content

Commit 2ff547c

Browse files
committed
Update README for 2.3r1
1 parent 943dff1 commit 2ff547c

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
As of 03/17/22, x2 is discontinued in favor of [Calcium](https://github.com/dm12332131md/calcium).
2-
This repository will stay active for future reference.
3-
41
# x2
52

6-
## Welcome
3+
## Introduction
4+
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.
76

8-
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.
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.
98

109
## Table of Contents
1110

1211
- **Home ▾**
13-
- [Welcome](#welcome)
14-
- [Table of Contents](#table-of-contents)
12+
- [Introduction](#introduction)
13+
- [ToC](#table-of-contents)
1514
- [About](#about)
1615
- [Getting Started ▾](#getting-started)
1716
- [Step 1: Installation](#step-1-installation)
@@ -26,19 +25,20 @@ Welcome to the official documentation of x2! This documentation will get you sta
2625
- [Python API](./md/pythonAPI.md)
2726
- [Standard Library](./md/standardLibrary.md)
2827

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

31-
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).
3233

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

4343
## Getting Started
4444

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

6363
### Step 2: Set-Up
6464

65-
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:
6666

6767
```xt
6868
:: Main
69-
:main
70-
out "Hello, world!"
69+
prt "Hello, world!"
7170
```
7271

73-
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.
7473

75-
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:
7675

7776
```xtconfig
7877
{
79-
"main": "main.xt"
78+
"main": "main.x2"
8079
}
8180
```
8281

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

117116
- [iiPython](https://github.com/ii-Python/) - Lead Developer
118-
- [Dm123321_31mD](https://github.com/Dm12332131mD) - Contributor
117+
- [Dm123321_31mD](https://github.com/Dm12332131mD) - Developer + moral support
119118

120119
### Resouces
121120

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

126125
---
127126

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

130-
[↑ Go To Top](#x2)
129+
[↑ Go To Top](#x2)

0 commit comments

Comments
 (0)