---

epi2

In this repo you can find the code of epi2 programming language.

Table of contents

• Pre-Requisites for installing epi2
• Installation for Windows using cmd
• Installation for Windows using PowerShell
• Installation for Linux using Shell
• Colaborate to this project
• License

Pre-Requisites for installing epi2

• Have installed MSYS mingw64 for using g++ on the console.
• Optionally have Git, GitHub Desktop or GitHub CLI installed for commits directly from console
• For making the icon be an object file I used WiX Toolset

Installation for Windows using cmd

1. Clone or download this repository to a folder. Git: git clone https://github.com/eLiteEs/epi2.git GitHub CLI: gh repo clone eLiteEs/epi2 or download the code from GitHub.
2. Open the folder and run the script install.bat. That script will build the project using g++, create a folder on your user folder, move all epi2 files into that folder and add epi2 to PATH enviroment variable.
3. Then you can use epi2 on Terminal.

Note: You should have g++ installed for installing epi2. Until I don't sign the program, this will be required, if not Windows Defender will mark this software as malware.

Installation for Windows using PowerShell

1. Clone or download this repository to a folder. Git: git clone https://github.com/eLiteEs/epi2.git GitHub CLI: gh repo clone eLiteEs/epi2 or download the code from GitHub.
2. Open the folder and run the script install.ps1. That script will build the project using g++, create a folder on your user folder, move all epi2 files into that folder and add epi2 to PATH enviroment variable.
3. Then you can use epi2 on Terminal.

Note: You should have g++ installed for installing epi2. Until I don't sign the program, this will be required, if not Windows Defender will mark this software as malware.

Installation for Linux using Bash

1. Clone or download this repository to a folder. Git: git clone https://github.com/eLiteEs/epi2.git GitHub CLI: gh repo clone eLiteEs/epi2 or download the code from GitHub.
2. Run make install to build and install epi2 in your system.

NOTE: After running make install be sure to run source ~/.bashrc` for adding epi2 executables to PATH.

Colaborating to this project

Table of contents

1. Creating and Issue
2. Adding things to the documentation
3. Cloning this repository
4. Writing the Code
5. Building the Code
6. Creating Pull Requests
7. Forking this repository

Creating an Issue

You can write an Issue on GitHub if you're finding a bug on the program or if you want to add some documentation for the program by doing this:

• If it's a bug:

  1. Be sure to add a description about how to recreate it.
  2. You can add the platform in which you're finding the bug.
  3. Also add the expected output into that problem
  4. If you want add a possible way of fixing it.

• If you want to add documentation: You can create issues if you think that documentation is missing or if you think that it misght be wrong. You can also edit files of the documentaion and create pull requests.

Adding things to the documentation

If you find some documentation weak or if it contains errors, you can edit them and create a pull request adding information about what was wrong and what changes you made.

Cloning this repository

You can clone this repository using Git like this:

git clone https://YourUsename@github.com/eLiteEs/epi2.git

Writing the code

Always try avoiding external libraries and try to comment all the code that you write. Don't change the tab indent on the files, normally epi2 is written with 4 spaces indent.

Building the project

On Windows you can run build.bat or build.ps1 scripts for building the executables of epi2. You can also run the test.exe file for checking if the code has some performance issues. On Linux you can use the make build script for building the project and make test or make full-test scripts for checking if the code has performance issues.

Creating Pull Requests

If you create a Pull Request add a description about what did you changed and how it was before. If it's a new feature be sure that it works correctly.

Forking this repository

You can use epi2 for creating you own programming languege but you may add the ² symbol to the name.

License

This project is licensed by the GNU General Public License v3 available at LICENSE file.