Skip to content

Suggest using degit for starting out #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Suggest using degit for starting out #50

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97de538
Suggest using degit for starting out
Crisfole Jun 14, 2019
0ea557c
Update README.md
Crisfole Feb 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ console.log('it will be lunchtime in ' + howLongTillLunch());

## Getting started

### Degit

The easiest way to use this as a base project is to use [degit](Rich-Harris/degit)!

```bash
npx degit https://github.com/rollup/rollup-starter-lib my-library
cd my-library
npm install
```

### Clone

Clone this repository and install its dependencies:

```bash
Expand All @@ -20,6 +32,10 @@ cd rollup-starter-lib
npm install
```

*Note:* this technique keeps the git history from this repository, which you probably do not want in your library.

## Using rollup-starter-lib

`npm run build` builds the library to `dist`, generating three files:

* `dist/how-long-till-lunch.cjs.js`
Expand Down