-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added simplified patterns.ne as an overview of the grammar; values ca…
…n now be a range like 1..10
- Loading branch information
1 parent
3631f5d
commit 2ffca66
Showing
10 changed files
with
942 additions
and
197 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# NearleyGram - Developer Notes | ||
|
||
Written in [nearley](https://nearley.js.org), managed with [nx.dev](https://nx.dev) | ||
|
||
## Run tasks | ||
|
||
Build the grammar: | ||
|
||
```sh | ||
npx nx build | ||
``` | ||
|
||
Test the grammar: | ||
|
||
```sh | ||
npx nx test | ||
``` | ||
|
||
Build a railroad diagram of the grammar: | ||
|
||
```sh | ||
npm run build:railroad | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,60 +1,16 @@ | ||
# NearleyGram | ||
|
||
<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> | ||
Gram is a subject based notation for structured data. | ||
|
||
✨ Your new, shiny [Nx workspace](https://nx.dev) is almost ready ✨. | ||
This project is a [nearley](https://nearley.js.org) grammar for gram, providing | ||
an EBNF-like description that produces convenient railroad diagrams. | ||
|
||
[Learn more about this workspace setup and its capabilities](https://nx.dev/nx-api/js?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed! | ||
## About `gram` | ||
|
||
## Finish your CI setup | ||
Gram notation describes subjects, which are like objects with benefits. | ||
|
||
[Click here to finish setting up your workspace!](https://cloud.nx.app/connect/R1YlU1ynlz) | ||
There are 3 primary structures which can be defined: | ||
|
||
|
||
## Run tasks | ||
|
||
To build the library use: | ||
|
||
```sh | ||
npx nx build | ||
``` | ||
These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files. | ||
|
||
[More about running tasks in the docs »](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
|
||
## Versioning and releasing | ||
|
||
To version and release the library use | ||
|
||
``` | ||
npx nx release | ||
``` | ||
|
||
Pass `--dry-run` to see what would happen without actually releasing the library. | ||
|
||
[Learn more about Nx release »](hhttps://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
|
||
|
||
[Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
|
||
## Install Nx Console | ||
|
||
Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ. | ||
|
||
[Install Nx Console »](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
|
||
## Useful links | ||
|
||
Learn more: | ||
|
||
- [Learn more about this workspace setup](https://nx.dev/nx-api/js?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
- [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
- [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
- [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
|
||
And join the Nx community: | ||
- [Discord](https://go.nx.dev/community) | ||
- [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl) | ||
- [Our Youtube channel](https://www.youtube.com/@nxdevtools) | ||
- [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
- independent subjects: ```(a:Person {name:"ABK"})``` | ||
- subject relationships: ```(a)-[:KNOWS]->(b)``` | ||
- associated subjects: ```[people | a,b,c]``` |
Oops, something went wrong.