Skip to content

Commit 28d047b

Browse files
committed
udpate readme
1 parent 6fa3df1 commit 28d047b

File tree

1 file changed

+6
-52
lines changed

1 file changed

+6
-52
lines changed

README.md

Lines changed: 6 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,11 @@
1-
# Platform
1+
# Angular Three workspace
22

3-
<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
3+
Here, you'll find the source code for the entire `angular-three` ecosystem, the documentation, and the examples.
44

5-
**This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)**
5+
## Documentation
66

7-
## Generate code
7+
The documentation is available at [angularthree.netlify.app](https://angularthree.netlify.app).
88

9-
If you happen to use Nx plugins, you can leverage code generators that might come with it.
9+
## Examples
1010

11-
Run `nx list` to get a list of available plugins and whether they have generators. Then run `nx list <plugin-name>` to see what generators are available.
12-
13-
Learn more about [Nx generators on the docs](https://nx.dev/plugin-features/use-code-generators).
14-
15-
## Running tasks
16-
17-
To execute tasks with Nx use the following syntax:
18-
19-
```
20-
nx <target> <project> <...options>
21-
```
22-
23-
You can also run multiple targets:
24-
25-
```
26-
nx run-many -t <target1> <target2>
27-
```
28-
29-
..or add `-p` to filter specific projects
30-
31-
```
32-
nx run-many -t <target1> <target2> -p <proj1> <proj2>
33-
```
34-
35-
Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/core-features/run-tasks).
36-
37-
## Want better Editor Integration?
38-
39-
Have a look at the [Nx Console extensions](https://nx.dev/nx-console). It provides autocomplete support, a UI for exploring and running tasks & generators, and more! Available for VSCode, IntelliJ and comes with a LSP for Vim users.
40-
41-
## Ready to deploy?
42-
43-
Just run `nx build demoapp` to build the application. The build artifacts will be stored in the `dist/` directory, ready to be deployed.
44-
45-
## Set up CI!
46-
47-
Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further.
48-
49-
- [Set up remote caching](https://nx.dev/core-features/share-your-cache)
50-
- [Set up task distribution across multiple machines](https://nx.dev/core-features/distribute-task-execution)
51-
- [Learn more how to setup CI](https://nx.dev/recipes/ci)
52-
53-
## Connect with us!
54-
55-
- [Join the community](https://nx.dev/community)
56-
- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools)
57-
- [Follow us on Twitter](https://twitter.com/nxdevtools)
11+
The examples are available at [angularthreedemo.netlify.app](https://angularthreedemo.netlify.app).

0 commit comments

Comments
 (0)