Skip to content

Commit

Permalink
- Init
Browse files Browse the repository at this point in the history
- set up package
- folder structure
- basic readme
  • Loading branch information
AllanOcelot committed Sep 1, 2024
1 parent e5b1584 commit c682723
Show file tree
Hide file tree
Showing 7 changed files with 327 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

.vs/*
node_modules/*
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# xenoterminal
# Xeno Terminal
A CSS framework to style common sites in the theme of classic CRT/Sci fi terminals.

# How To Use
You can install via npm
```
npm i @allanocelot/xenoterminal
```

then import the Lib anywhere you'd like to use it.


```
@import "@allanocelot/xenoterminal";
```


# Contributing
Clone repo locally
```
npm install
```

run

```
npm run build
```

to compile src scss down to css in dist. Open a PR.



# Notes
This is just a super goofy hobby project. Please don't expect consistent updates as I'm much too busy with my actual dev work / life. Thanks!


1 change: 1 addition & 0 deletions dist/index.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*{display:none}/*# sourceMappingURL=index.css.map */
1 change: 1 addition & 0 deletions dist/index.css.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

252 changes: 252 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 30 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"name": "@allanocelot/xenoterminal",
"version": "1.0.0",
"description": "A simple collection of CSS that styles websites in the asthetic of CRT / Sci Fi computers",
"main": "main.scss",
"scripts": {
"build": "sass src/main.scss dist/index.css --style=compressed"
},
"repository": {
"type": "git",
"url": "xenoterminal"
},
"keywords": [
"css",
"alien",
"framework",
"fun",
"console",
"simple",
"clear",
"minimal",
"80s",
"scifi"
],
"author": "Allan Ocelot",
"license": "ISC",
"devDependencies": {
"sass": "^1.77.8"
}
}
4 changes: 4 additions & 0 deletions src/main.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// build test
* {
display: none;
}

0 comments on commit c682723

Please sign in to comment.