heron

README

a powerful CSS preprocessor

Table of Contents

• Advantages
• Planned features
• Installation for Windows
• Installation for other operating systems
• Installation with Go CLI
• Usage

Advantages

• creates small and compact CSS
• supports nested selectors
• single-line and multi-line comments

Planned Features

• variables
• mixins
• standard library

Installation

If you have windows, you can just download the installer from Github releases

If you don't use windows

• install the raw executable from the dist folder
• To use the executable anywhere from the command line, add it to your PATH

Or, if you have Go

Run go install github.com/PoseidonCoder/heron in the command line. This will fetch the package, compile the project, and add it to your PATH

PATH is a system variable that contains programs which are allowed to run anywhere from the command line

Usage

demo.he

ul {
    li {
        color: purple; //the text of the list items within this list will be purple
    }

    background-color: blue; //the unordered list will have a blue background
}

To compile this bit of Heron code run the following in your terminal:

command-line

heron demo.he

Heron will automatically create demo.css if the output file is not found

demo.css

ul li {
    color: purple;
}

ul {
    background-color: blue;
}

Contributing to Heron (I can't do this all by myself)

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin <project_name>/<location>
5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Note: this project is still a work in progress and therefore still has many flaws