Skip to content

Commit 8f96a31

Browse files
committed
Updated README
1 parent f8ae506 commit 8f96a31

File tree

1 file changed

+16
-31
lines changed

1 file changed

+16
-31
lines changed

README.md

+16-31
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
1+
A website for the JavaScript version of [FPTaylor](https://github.com/soarlab/FPTaylor).
2+
13
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
24

5+
## Installation
6+
7+
1) Clone the repository and run `npm install` in the project directory.
8+
9+
2) Obtain `fptaylor.js` and copy it to the `public` directory. Either see [FPTaylor's instructions](https://github.com/soarlab/FPTaylor#JavaScript) or download [`fptaylor.js`](https://github.com/monadius/FPTaylorJS/blob/gh-pages/fptaylor.js) from the [`gh-pages`](https://github.com/monadius/FPTaylorJS/tree/gh-pages) branch of this repository.
10+
11+
Note: if you build `fptaylor.js` yourself then also copy a new version of `default_config.js` to `src`.
12+
13+
## Deployment
14+
15+
See Create React App [instructions](https://create-react-app.dev/docs/deployment/). Don't forget to change
16+
the `homepage` in `package.json`.
17+
318
## Available Scripts
419

520
In the project directory, you can run:
@@ -35,34 +50,4 @@ If you aren’t satisfied with the build tool and configuration choices, you can
3550

3651
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
3752

38-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
39-
40-
## Learn More
41-
42-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
43-
44-
To learn React, check out the [React documentation](https://reactjs.org/).
45-
46-
### Code Splitting
47-
48-
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
49-
50-
### Analyzing the Bundle Size
51-
52-
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
53-
54-
### Making a Progressive Web App
55-
56-
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
57-
58-
### Advanced Configuration
59-
60-
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
61-
62-
### Deployment
63-
64-
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
65-
66-
### `npm run build` fails to minify
67-
68-
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
53+
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

0 commit comments

Comments
 (0)