Add Building and License sections to the readme.
This commit is contained in:
parent
cb2e5e9f17
commit
2e828eb087
27
README.md
27
README.md
|
@ -3,3 +3,30 @@
|
||||||
> https://href.plus
|
> https://href.plus
|
||||||
|
|
||||||
* If you find a release that has a link which just shows the domain and not a proper name, please post it in [#5](https://github.com/Bauke/href-plus/issues/5). Thank you!
|
* If you find a release that has a link which just shows the domain and not a proper name, please post it in [#5](https://github.com/Bauke/href-plus/issues/5). Thank you!
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
*Requires a recent version of [Node](https://nodejs.org) and [pnpm](https://pnpm.io).* In the command-line:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Clone the repository.
|
||||||
|
git clone https://github.com/Bauke/href-plus.git
|
||||||
|
|
||||||
|
# Move into it.
|
||||||
|
cd href-plus
|
||||||
|
|
||||||
|
# Install the dependencies.
|
||||||
|
pnpm install
|
||||||
|
|
||||||
|
# Start a local development server.
|
||||||
|
pnpm start -- --open
|
||||||
|
|
||||||
|
# Build for production.
|
||||||
|
pnpm vite build --emptyOutDir
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the [GPL-3.0-or-later](LICENSE) license.
|
||||||
|
|
||||||
|
Icons in [`source/assets/icons`](source/assets/icons) belong to their respective owners.
|
||||||
|
|
Loading…
Reference in New Issue