Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobxperez committed Oct 25, 2023
1 parent bcf8925 commit fa4b3c1
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,15 @@ On your terminal run these scripts to compile

## Framework

We are using [Rams](https://github.com/jacobxperez/rams) as our website framework.
We are using [Rams](https://github.com/jacobxperez/rams) as our website framework. Do **not** edit the [core](https://github.com/jacobxperez/atkinson-hyperlegible-pro/tree/website/src/css/core) files because they are part of the Rams core framework files. However, you can edit the [custom](https://github.com/jacobxperez/atkinson-hyperlegible-pro/tree/website/src/css/custom) folder files the [main.css](https://github.com/jacobxperez/atkinson-hyperlegible-pro/blob/website/src/css/main.css) or the [var.css](https://github.com/jacobxperez/atkinson-hyperlegible-pro/blob/website/src/css/var.css) if any change is accepted by the maintainers. Any new CSS file should be added in the [custom](https://github.com/jacobxperez/atkinson-hyperlegible-pro/tree/website/src/css/custom) folder then linked in the [main.css](https://github.com/jacobxperez/atkinson-hyperlegible-pro/blob/website/src/css/main.css) file for compiling.

## CSS Files

- [/css](https://github.com/jacobxperez/rams/tree/master/src/css/)
- [core](https://github.com/jacobxperez/rams/tree/master/src/css/core) (important files for compiling)
- [custom](https://github.com/jacobxperez/rams/tree/master/src/css/custom) (add custom modules here)
- [main.css](https://github.com/jacobxperez/rams/blob/master/src/css/main.css) (compile to produce the final CSS)
- [var.css](https://github.com/jacobxperez/rams/blob/master/src/css/var.css) (variables for font, colors, and more)

## LICENSE

Expand Down

0 comments on commit fa4b3c1

Please sign in to comment.