Skip to content

Commit cfc87ca

Browse files
committed
Add more details in readme
1 parent 9348d63 commit cfc87ca

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@ React Component for editing JSON data using form inputs.
66

77
1. Clone the repo.
88
2. Run `npm install` to install packages required for development.
9-
3. Run `npm run dev`. This will start a script which will automatically compile
9+
3. The source files are in `src/` directory. These are the files you need to change.
10+
4. Run `npm run dev`. This will start a script which will automatically compile
1011
js files upon changes.
11-
4. Open a new terminal and:
12-
1. Go into `dev/` directory: `cd dev`.
13-
2. Run `python3 -m http.server` This will start a server at `localhost:8888`.
1412

13+
**To view your changes**, use the `dev/index.html` file. This is used for rendering
14+
the library while developing it.
1515

16-
There's a `dev/index.html` file which will be served by the Python server.
17-
This is used for rendering and developing the library.
16+
1. Open a new terminal
17+
2. Go into `dev/` directory: `cd dev`.
18+
3. Run `python3 -m http.server` This will start a server at `localhost:8888`.
19+
This will serve the `dev/index.html` file.
1820

1921
Currently, there's no hot-reloading set up, so when you make changes you'll
2022
have to reload the page manually to view changes.

0 commit comments

Comments
 (0)