Skip to content

Commit 90a8990

Browse files
committed
docs: update readme
1 parent ad77437 commit 90a8990

File tree

2 files changed

+96
-2
lines changed

2 files changed

+96
-2
lines changed

README.md

Lines changed: 96 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,96 @@
1-
# lib
2-
📦 Component Library of SciuxKit
1+
![Cover](./assets/cover.png)
2+
3+
# 📦 Sciux - AI Science Creation Kit
4+
5+
Sciux `/ˈsaɪ.næks/` is a creation kit to build interactive STEM content with DSL (Domain Specific Language).
6+
7+
Sciux ecosystem includes:
8+
9+
- [Sciux Lib](https://github.com/sciux-kit/lib) The standard components library for Sciux, includes most of STEM-usual components.
10+
- [Sciux Laplace](https://github.com/sciux-kit/laplace) The renderer of Sciux DSL without any components.
11+
12+
> This repository is the standard components library for Sciux.
13+
14+
## Installation
15+
16+
```bash
17+
npm install sciux # npm
18+
pnpm add sciux # pnpm
19+
yarn add sciux # yarn
20+
```
21+
22+
> `sciux` is a composing package includes all the components in the repository
23+
24+
## Usage
25+
26+
``` ts
27+
import initializeSciux from 'sciux'
28+
29+
initializeSciux()
30+
```
31+
32+
It will register all the components in the repository to the global scope.
33+
34+
Now we have the following sciux code:
35+
36+
``` html
37+
<rows>
38+
<flexbox>1</flexbox>
39+
<columns>
40+
<flexbox>2-1</flexbox>
41+
<flexbox>2-2</flexbox>
42+
</columns>
43+
<columns>
44+
<flexbox>3-1</flexbox>
45+
<flexbox>3-2</flexbox>
46+
<flexbox>3-3</flexbox>
47+
</columns>
48+
</rows>
49+
```
50+
51+
Now render it on your page:
52+
53+
``` ts
54+
import initializeSciux, { render } from 'sciux'
55+
56+
initializeSciux()
57+
58+
const root = document.getElementById('app')
59+
const code = `The sciux code...`
60+
61+
render(code, root)
62+
```
63+
64+
## Why Name 'Sciux'
65+
66+
Sciux is composed by two words:
67+
68+
```txt
69+
sci + ux = Sciux
70+
science + UX (User Experience) = Sciux
71+
```
72+
73+
`sci` is the abbreviation of `science`, and `ux` is the abbreviation of interaction.
74+
75+
## Packages
76+
77+
| Package | Description |
78+
| --- | --- |
79+
| `sciux` | The core package of Sciux, includes all the components. |
80+
| `sciux-laplace` | The renderer of Sciux DSL without any components. |
81+
| `@sciux/widget` | The display components for Sciux. |
82+
| `@sciux/layout` | The layout components for Sciux. |
83+
| `@sciux/model` | The interactive form components for Sciux. |
84+
| More | More STEM components is coming soon... |
85+
86+
## Contributors
87+
88+
> Sciux Library
89+
90+
![lib](https://contrib.rocks/image?repo=sciux-kit/lib)
91+
92+
> Sciux Laplace
93+
94+
![lib](https://contrib.rocks/image?repo=sciux-kit/laplace)
95+
96+
***Copyright (c) 2025-present**, Sciux Community & BijonAI Team. All rights reserved.*

assets/cover.png

285 KB
Loading

0 commit comments

Comments
 (0)