Skip to content

Commit

Permalink
Merge pull request #12 from aws4embeddedlinux/README
Browse files Browse the repository at this point in the history
README: add development setup
  • Loading branch information
nateglims authored Sep 13, 2023
2 parents 86b5504 + 09a6114 commit 62a80a8
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

TODO: Fill this README out!


### Development Setup

You can use [`npm link`](https://docs.npmjs.com/cli/v10/commands/npm-link) to develop with a checked out copy of this repo.

```bash
# In this library repo:
$ npm link
$ cd your-project
$ npm link aws4embeddedlinux-ci
```

This will link through the system `node_modules` install. When using a system node install on Linux, this can require sudo access. To avoid this, use a [node version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-version-manager-to-install-nodejs-and-npm) or [set a node prefix](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally).


Be sure to:

* Change the title in this README
Expand Down

0 comments on commit 62a80a8

Please sign in to comment.