diff --git a/LICENSE b/LICENSE.md similarity index 95% rename from LICENSE rename to LICENSE.md index 615e0d5..326dfd0 100644 --- a/LICENSE +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2019 Stephan +Copyright (c) 2016 till today Stephan Hagedorn Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md new file mode 100644 index 0000000..842b787 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# HIPPIE styles + +Collection of CSS styles, mainly for the use with HIPPIE, written in SASS language. + +## Getting Started + +These instructions will get you a copy of the project up and running on your local machine. + +### Prerequisites + +All styles in this project are written in the [Sass](https://sass-lang.com/) language. So a preprocessor may be needed to form Cascading Style Sheets (CSS). + +Please choose a implementation suitable for your needs from the [Install Sass document](https://sass-lang.com/install). + +For example in a Node.js environment you can install Sass with the Node package manager: + +```bash +npm install -g sass +``` + +### Installing + +Clone the repository `https://github.com/sthag/hippie-styles.git` to a folder to get all source files. + +To include HIPPIE styles to a Sass workflow, just import the main file at the appropriate position. Usually this would be at the beginning of your stylesheet: + +```scss +@import "hippie/hippie"; +``` + +It is also possible to link to the resulting CSS file. First the file needs to be compiled: + +``` +sass hippie/_hippie.scss stylesheets/hippie.css +``` + +Now the stylesheet can be included into the HTML document: + +``` + +``` + +## Versioning + +This project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/hippie-styles/tags). + +## Authors + +* **Stephan Hagedorn** - *Initial work* - [Interaktionsweise](https://interaktionsweise.de) + +See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details diff --git a/_basic.scss b/_basic.scss index 789ec50..e18dfe8 100644 --- a/_basic.scss +++ b/_basic.scss @@ -1,7 +1,7 @@ // Reset // Use a file outside of hippie i.e. vendor/normalize.css // ----------------------------------------------------------------------------- -@import "../../vendor/normalizecss/normalize.css"; +// @import "../../vendor/normalizecss/normalize.css";