Skip to content

Commit

Permalink
Merge pull request #32 from decentralized-identity/readme/wsl2+nvm-ve…
Browse files Browse the repository at this point in the history
…rsion

add dependencies/pre-setup step and WSL2 link
  • Loading branch information
csuwildcat committed Aug 2, 2023
2 parents ea787b7 + e736d62 commit 6172210
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions readme.md
Expand Up @@ -16,6 +16,7 @@ Spec-Up is a technical specification development tool that enables you to create

Installing Spec-Up is easy peasy lemon squeezy:

0. Node.JS, i.e. `nvm` and its package manager `npm`, are required to run spec-up. WSL2 users should look [here](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl#install-nvm-nodejs-and-npm) for specific instructions.
1. Run `npm install spec-up` in the root directory of the repo to install all dependencies.
2. Create a `specs.json` file **in the root folder of your repository** to specify configuration values used in the generation of your spec documents. The values in your `specs.json` file include things like where your spec's markdown files are located, where to output the generated spec document, and various metadata values used in rendering, such as the title, logo, and repo links for each of your specs. The following are the required/optional fields supported in the `specs.json` config file:

Expand Down Expand Up @@ -137,3 +138,13 @@ Additionally, some editors may prefer to keep an immutable archive in a system l
```
**Specification Status:** Draft V0.1 (snapshotted and archived on [web.archive.org](https://web.archive.org/web/20211206215823/https://identity.foundation/waci-presentation-exchange/))
```

## Troubleshooting

- WSL2 users are recommended to use the `bash` option rather than `PowerShell` in the terminal of Visual Studio Code.
- Some users have reported problems using spec-up with node versions 15+; to pin to an older version, simple run:
```
nvm install 14
nvm use 14
npm i npm@6.14.16 -g
```

0 comments on commit 6172210

Please sign in to comment.