Skip to content

Commit 06e1a0e

Browse files
committed
UPDATE: Link development guide
1 parent 09163fe commit 06e1a0e

File tree

2 files changed

+42
-36
lines changed

2 files changed

+42
-36
lines changed

README.md

+2-36
Original file line numberDiff line numberDiff line change
@@ -21,39 +21,5 @@ The [`/packages`](/packages) directory contains the codebase for all Pycord UI i
2121
The [`/tests`](/tests) directory contains all the test files for testing the implementations.
2222

2323
## Local Development
24-
Fork and clone the repository
25-
```sh
26-
$ git clone https://github.com/<your-username>/pycord-ui
27-
```
28-
29-
### Installing Dependencies
30-
To install dependencies run the script below in your terminal.
31-
```sh
32-
# NPM
33-
$ npm install
34-
35-
# Yarn
36-
$ yarn
37-
```
38-
39-
### Test building the files (CSS)
40-
To test build the files in the `/tests` directory, run this NPM script in your terminal:
41-
```sh
42-
# NPM
43-
$ npm run test:sass
44-
45-
# Yarn
46-
$ yarn test:sass
47-
```
48-
This generates `*.css` files for you to check for unexpected behaviors.
49-
50-
### Building the files for distribution (CSS)
51-
To build the files, run this NPM script in your terminal:
52-
```sh
53-
# NPM
54-
$ npm run test:sass
55-
56-
# Yarn
57-
$ yarn test:sass
58-
```
59-
This generates a `build.css` file in `/packages/pycui/`.
24+
- [CSS implementation](docs/pycui/developing.md)
25+
- React implementation (TBA)

docs/pycui/developing.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Developing Pycord UI (CSS)
2+
Below is a guide on developing Pycord UI.
3+
4+
## Local Development
5+
Fork and clone the repository
6+
```sh
7+
$ git clone https://github.com/<your-username>/pycord-ui
8+
```
9+
10+
### Installing Dependencies
11+
To install dependencies run the script below in your terminal.
12+
```sh
13+
# NPM
14+
$ npm install
15+
16+
# Yarn
17+
$ yarn
18+
```
19+
20+
### Test building the files (CSS)
21+
To test build the files in the `/tests` directory, run this NPM script in your terminal:
22+
```sh
23+
# NPM
24+
$ npm run test:sass
25+
26+
# Yarn
27+
$ yarn test:sass
28+
```
29+
This generates `*.css` files for you to check for unexpected behaviors.
30+
31+
### Building the files for distribution (CSS)
32+
To build the files, run this NPM script in your terminal:
33+
```sh
34+
# NPM
35+
$ npm run test:sass
36+
37+
# Yarn
38+
$ yarn test:sass
39+
```
40+
This generates a `build.css` file in `/packages/pycui/`.

0 commit comments

Comments
 (0)