Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Changed readme to fit new repository #2

Merged
merged 1 commit into from
Apr 28, 2023
Merged

Changed readme to fit new repository #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 9 additions & 18 deletions .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
<p align="center">
<img src="https://github.com/I-Language-Development/I-language/blob/main/.github/logo-with-text.png" height="100px">
<img src="https://github.com/I-Language-Development/I-language-rust/blob/main/.github/logo-with-text.png" height="100px">
</p>
<h3 align="center">
The I programming language is a high level programming language written in pure python.
The I programming language is a high level programming language written in rust.
</h3>
<p align="center">
<img src="https://www.codefactor.io/repository/github/i-language-development/i-language/badge">
<img src="https://github.com/I-Language-Development/I-language/actions/workflows/pylint.yml/badge.svg">
<img src="https://github.com/I-Language-Development/I-language/actions/workflows/ruff.yml/badge.svg">
<img src="https://github.com/I-Language-Development/I-language/actions/workflows/bandit.yml/badge.svg">
<img src="https://github.com/I-Language-Development/I-language/actions/workflows/pytest.yml/badge.svg">
<img src="https://github.com/I-Language-Development/I-language/actions/workflows/mypy.yml/badge.svg">
<img src="https://www.codefactor.io/repository/github/i-language-development/i-language-rust/badge">
<img src="https://github.com/I-Language-Development/I-language/actions/workflows/megalinter.yml/badge.svg">
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit">
</p>

<img src="https://github.com/I-Language-Development/I-language/blob/main/.github/example-syntax.png?raw=true" width="500px"/>
<img src="https://github.com/I-Language-Development/I-language-rust/blob/main/.github/example-syntax.png?raw=true" width="500px"/>

## About this project
Have you been dreaming about coding in your perfect programming language?
Expand All @@ -25,20 +21,15 @@ Here is the power of some of the best languages combined.
### Download from releases
Navigate to the releases tab and select the newest release. Download the version fitting your OS and run the installer.

### Pip
To install the package via pip, run `pip install ilanguage` (The `pip` command might be called differently depending on
your OS). The installer will be executed automatically. If you use pip to install the package, you will be able to use
`python -m ilanguage ARGUMENTS` just like `ilanguage ARGUMENTS`.

### Git
To clone the repository locally using git run `git clone https://github.com/I-Language-Development/I-language.git`.
To clone the repository locally using git run `git clone https://github.com/I-Language-Development/I-language-rust.git`.

## Your first program
To make a simple hello world program follow the instructions below:
1. Create a file ending with `.ilang`.
2. Open the file and write `output("Hello world!")` to it.
1. Create a file ending with `.il`.
2. Open the file and write `output("Hello world!");` to it.
3. Open the path of the file in your terminal and type `ilanguage FILE` where `FILE` is the name of the file including
the `.ilang` file extension.
the `.il` file extension.
4. You should see "Hello world!" in your terminal.

That's it! It's literally so easy.